Donate Share

Natural Docs

Tracker: Bugs

5 fails to generate output - ID: 2208786
Last Update: Comment added ( gregvalure )

I'm trying to use NaturalDocs to document a project and it's not generating
any documentation (it is generating a set of directories and files, just no
documentation).

$ naturaldocs -i iulib -o HTML temp -p temp-proj -r
Finding files and detecting changes...
Parsing 62 files...
Updating menu...
Updating CSS file...
Done.
$ naturaldocs -h | head
Natural Docs, version Development Release 12-07-2007 (1.35 base)
http://www.naturaldocs.org
This program is licensed under the GPL
--------------------------------------

Syntax:

NaturalDocs -i [input (source) directory]
(-i [input (source) directory] ...)
-o [output format] [output directory]
$


iulib is a source tree containing standard C++ code with standard C++
extensions (.cc, .h). NaturalDocs should generate reasonable output with
its default settings for such input.


Tom ( tmber ) - 2008-10-30 02:34

5

Open

None

Nobody/Anonymous

None

None

Public


Comment ( 1 )




Date: 2008-10-30 02:39
Sender: gregvalureProject Admin

Have you written any comments in Natural Docs' format? C++ has basic
language support which means it will not auto-document your code, it will
only pick out the comments you have written specifically for it.

If you have written comments for Natural Docs, please post one here along
with a couple of lines before and after it so I can see what's wrong.

Also, Natural Docs doesn't recognize .cc files by default. That's a new
one for me; I've seen .c, .cpp, .cxx, but not .cc so you'll have to add
that to Languages.txt. Go to Natural Docs' install directory, the Config
subdirectory, open Languages.txt, find C/C++, and add cc to the list of
extensions.


Log in to comment.

Attached File

No Files Currently Attached

Change

No changes have been made to this artifact.