ringabout
b8ce11dd9d
fixes #25027 ; nim doc uses doc comment from private field for public field ( #25239 )
...
fixes #25027
2025-10-23 19:19:27 +02:00
ringabout
be0b847213
closes #15176 ; adds a test case ( #23248 )
...
closes #15176
2024-01-22 22:32:10 +08:00
Jake Leahy
17915d93bf
Fix non-toplevel fields in objects not getting rendered ( #22266 )
...
* Add example object into testproject
The proc is there to check the case of an identDef being inside an identDef (We do want to render those even if they are not exported)
* Add `inside` set to `TSrcGen` which allows us to see what context we are in
This is done instead of adding another inXyz bool parameter
We then use this to know if we are inside an object when rendering an nkIdentDefs (To know if we need to skip rendering it)
* Update test files
2023-07-16 19:46:18 +02:00
ringabout
8e0f336f6d
fixes #21483 ; fixes nim doc skips documentation of annotated elements of objects ( #21743 )
...
* fixes #21483 ; skipPragmaExpr
* add a test case for #21483
* fixes HTML
2023-04-29 15:30:44 +02:00
ringabout
ff8ab06720
fixes #19396 ; Nimdoc hide nonexported fields ( #21305 )
...
* suppresses non-exported fields of types and adds command-line option to re-enable this if desired
* corrected the doctest that produced a CI error
* an embarrassingly bad error in reasoning
* modified a nimdoc test to reflect updated behavior
* needed another change to bring utils.html doctest in sync with update
* add info
* fix nimdoc
* lint
* render postfix
* fixes a problem
* fixes nimdoc
* fix nimdoc
---------
Co-authored-by: johnperry-math <john.perry@usm.edu >
Co-authored-by: johnperry-math <devotus@yahoo.com >
2023-02-01 08:13:40 +01:00
Jake Leahy
cbeefc877c
Docs expand using parameters ( #21076 )
...
* Trying to fix by changing renderer
* add renderExpandUsing flag
This flag makes the renderer expand parameters that use using statement to have their full type
* Update docs
* Make comment better explain why checking for nkSym
* Fix nil access when macro/template has parameter with no type
* Fix nil access when node is not semmed yet
2022-12-12 07:44:17 +01:00
Timothee Cour
488e9c2991
nim doc now correctly renders deprecated pragmas for routines and types ( #18515 )
2021-07-19 12:42:45 +02:00
Timothee Cour
e2ab08603d
fix warnings/hints in nimdoc/tester.nim ( #18083 )
...
* fix warnings/hints in nimdoc/tester.nim
* improve err msg for nimdoc/tester.nim and change flag from fixup to nimTestsNimdocFixup
* address comment: put back quit instead of doAssert
2021-05-30 22:40:42 +02:00
Timothee Cour
78e2d299df
typo: nonexistant => nonexistent ( #17918 )
...
* typo: nonexistant => nonexistent
* fix test (ordering differs because of https://github.com/nim-lang/Nim/issues/17910 )
2021-05-02 00:26:41 +02:00
Timothee Cour
a424075b5e
improve nimsuggest/tester, minor improvements to koch.nim ( #17879 )
...
* improve nimsuggest/tester
* koch improvements
2021-04-29 13:44:53 +02:00
flywind
a807233aeb
fix #17615(runnableExamples silently ignored if placed after some code) ( #17619 )
...
Co-authored-by: Timothee Cour <timothee.cour2@gmail.com >
2021-04-02 18:26:30 -07:00
Andrey Makarov
554fe8f88f
conservative approach to fix #15184 ( #16723 )
2021-01-15 00:53:36 +01:00
Miran
c0b76ef3cb
fix #16164 , render doc comments ( #16230 )
...
* fix #16164 , render doc comments
* add a test
2020-12-02 15:36:08 +01:00
Miran
bbe49a14ae
Correct all eggs ( #15906 )
...
* "eg" is a misspelled "egg", "e.g." is "exempli gratia"
* Also, "ie" is "i.e.".
2020-11-10 21:53:25 +01:00
Miran
28bbcd9d45
fix #15702 , show enum fields documentation ( #15792 )
2020-10-30 16:30:00 +01:00
Timothee Cour
2867a33ebc
fix #14846 ; add macros.extractDocCommentsAndRunnables ( #14849 )
...
* fix #14846 ; add macros.extractDocCommentsAndRunnables
* fixup
* update tests
* address comment
2020-07-01 09:26:23 +02:00
Timothee Cour
bb62feff72
fix #14691 docgen works again for methods ( #14701 )
...
* fix #14691 docgen methods
* fixup
2020-06-18 08:47:16 +02:00
Timothee Cour
0a27cca4b5
runnableExamples: correctly handle multiline string litterals ( #14492 )
...
* runnableExamples: correctly handle multiline string litterals
* address comments: improve doc comments + variable namings
2020-06-01 15:56:29 +02:00
Timothee Cour
e646c16e06
hotfix doc comments for procs without body ( #14494 )
2020-05-29 05:30:36 -07:00
Timothee Cour
579456d520
fix #14485 ( #14487 )
2020-05-28 19:00:36 -07:00
Timothee Cour
e013ebc91a
fix #8871 runnableExamples now preserves source code comments, litterals, and all formatting; other bug fix ( #14439 )
...
* fix #8871 runnableExamples now preserves source code comments, litterals, and all formatting
* remove orig deadcode from getAllRunnableExamplesImpl
* fix expected examples
* add test to close https://github.com/nim-lang/Nim/issues/14473
* correctly handle regular comments before 1st token inside runnableExamples
* add test to answer https://github.com/nim-lang/Nim/pull/14439#discussion_r431829199
* update tests
2020-05-28 20:46:06 +02:00
Ridho Pratama
7ef4bffa79
renderer letAux fix only for octal literal ( #12343 )
...
* renderer letAux fix only for octal literal
* Handle when it's octal -1 for i64
* Added testcases
2019-10-08 11:12:24 +02:00
LemonBoy
7d217a71d3
Render deprecated pragmas ( #8886 )
...
* Render deprecated pragmas
* fix the expected html
* clean up the documentation regarding deprecations
* fix typo
* fix system.nim
* fix random
2019-06-03 10:15:20 +02:00
Jasper Jenkins
e64dde734b
Fixes #11078 ( #11079 )
...
* Fixes #11078
* Move to existing runnableExamples, update the expected html.
* Remove second comment token.
2019-04-23 14:20:27 +02:00
Araq
48f73aaa1c
docgen: fixes #9432 [backport]
2018-10-31 00:19:24 +01:00
LemonBoy
4d9aec1858
Revert #7964
...
Somehow the test case doesn't crash anymore and the regression in the
doc generation is fixed.
Fixes #9019
2018-09-21 18:59:46 +02:00
Araq
b9ed684dd2
index generation for docgen knows about subdirectories; index knows about enum values; fixes import statement for runnableExamples
2018-09-13 01:05:51 +02:00
Andreas Rumpf
b017138c32
added a test for 'nim doc'
2018-09-07 19:21:16 +02:00
