I've been trying to figure out how to make a top level module definition for my project.
I'm writing a project in C, and the first file contains the main method. I would like to have a top level explanation of what the program is and what it does. I thought it was something like this:
/****h* mc
* FUNCTION
* Main module for the monte carlo random number particle simulator
*****/
However, I get this error message when I run it:
$ robodoc --src mc.cu --doc index --singlefile --html
robodoc:
./mc.cu(1) : Warning R1:
Can't determine the "function" name.
I've noticed in the ROBODoc source code (robodoc.c), their top level comment looks like this:
/****h* Docuwala/ROBODoc
* FUNCTION
* ROBODoc is intended to be a replacement for the original AutoDocs
* program. ROBODoc will extract the comment headers from a source
* file, and put them into a separate documentation file.
* General Flow
*
* Sourcecode ---> [ROBODoc] ---> Document.
...
*
*****/
However, if you look at the html file generated, it does not have the "Docuwala" prefix in front of the "ROBODoc" name. How do I do that? I want the main header to be "mc", without the "/<some name>" part. I've read the manual, but it doesn't talk about how to do this.
Thanks for your help.
Craig
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Hi Craig / Thuffir,
this is a very late update to the question, but I figured it out:
Use the --sectionnameonly option
This hides the hierarchy
Cheers,
Geoff
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
I've been trying to figure out how to make a top level module definition for my project.
I'm writing a project in C, and the first file contains the main method. I would like to have a top level explanation of what the program is and what it does. I thought it was something like this:
/****h* mc
* FUNCTION
* Main module for the monte carlo random number particle simulator
*****/
However, I get this error message when I run it:
$ robodoc --src mc.cu --doc index --singlefile --html
robodoc:
./mc.cu(1) : Warning R1:
Can't determine the "function" name.
I've noticed in the ROBODoc source code (robodoc.c), their top level comment looks like this:
/****h* Docuwala/ROBODoc
* FUNCTION
* ROBODoc is intended to be a replacement for the original AutoDocs
* program. ROBODoc will extract the comment headers from a source
* file, and put them into a separate documentation file.
* General Flow
*
* Sourcecode ---> [ROBODoc] ---> Document.
...
*
*****/
However, if you look at the html file generated, it does not have the "Docuwala" prefix in front of the "ROBODoc" name. How do I do that? I want the main header to be "mc", without the "/<some name>" part. I've read the manual, but it doesn't talk about how to do this.
Thanks for your help.
Craig
Hi Craig!
Just try with a slash and then the top module definition. It's the way I am using it too.
Like:
/Top Module
....
Top Module/Sub Module
....
Best Regards,
Gergely Budai
Hi Craig / Thuffir,
this is a very late update to the question, but I figured it out:
Use the --sectionnameonly option
This hides the hierarchy
Cheers,
Geoff