jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Transforms docgen sample to be generated from source.

Browse source
This commit is contained in:
Grzegorz Adam Hankiewicz 2014-01-06 14:55:03 +01:00
commit 2ed7849921
5 changed files with 28 additions and 566 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/docgen.txt
View file

@ -97,7 +97,7 @@ Partial Output::
proc helloWorld*(times: int)
...
Output can be viewed in full here `sample.html <docgen_samples/sample.html>`_.
Output can be viewed in full here: `docgen_sample.html <docgen_sample.html>`_.
The next command, called ``doc2``, is very similar to the ``doc`` command, but
will be run after the compiler performs semantic checking on the input nimrod
module(s), which allows it to process macros.
@ -110,7 +110,7 @@ Partial Output::
proc helloWorld(times: int) {.raises: [], tags: [].}
...
The full output can be seen here `sample2.html <docgen_samples/sample2.html>`_.
The full output can be seen here: `docgen_sample2.html <docgen_sample2.html>`_.
As you can see, the tool has extracted additional information provided to it by
the compiler beyond what the ``doc`` command provides, such as pragmas attached
implicitly by the compiler. This type of information is not available from