multiple --src options?

[jwdevel]

Is there some Good Reason preventing ROBODoc from being able to take multiple --src options on the commandline?

For instance if you have
myproject/
myproject/src/
myproject/include/

And you want to spread your documentation between the source files and include files.

why can't you run, from myproject/, the command

robodoc --src ./src --src ./include --doc docs --singledoc

Or am I missing something obviuos (newbie to ROBODoc)

?

[David White]

For the example given, you could just start in the myproject folder and allow Robodoc to recourse through the folder tree. This is how I usually do my docs.

[jwdevel]

Well what I want to do is have my documentation in
myproject/docs

Is it ok to have the documentation in a subdirectory of the very folder I'm documenting?

like:
robodoc --src .\myproject --doc .\myproject\docs

that seems... "wrong" to me (:

[David White]

I guess Frans may need to answer that one definitely.  I use separate folders in my Dev or Prod folders for the source code and the documentation.  Part of the reason for this is that the source code is maintained under SVN, and since the docs are created from the source, I don't need to keep the docs under SVN as well.  Part of my .rc file is below ...

options:
    --src
    c:\Prod\ymdsrc
    --doc
    C:\Prod\ymddoc

[Frans Slothouber]

Hi,

It is allowed for the documentation directory to
be a subdirectory of the source directory.

So --src .\myproject --doc .\myproject\docs
is allowed.

See http://www.xs4all.nl/~rfsber/Robo/Manual/manual.html#id341115

Have fun,
Frans.