Hope I'm not wearing out my welcome with a bunch of questions at once! :o
So when I do a header like:
/****f* Section/Subsection
That makes the function a section to itself.
I'd like to then be able to document the variables as part of the same section. However, the only way I know how to do this would be to:
/****v* Section/ThisVariable
Also, what makes the links in the source work? Is it the Section/Subsection Definition? Or a "NAME" tag?
Thanks!
-Brett
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
If you define a header (/****f* Section/Subsection) it will appear as a section or even a separate file (--one_file_per_header).
If you wish to document multiple objects in one header you can assign multiple names to one header, altough they will have the same header type. (/****f* Section/Subsection1, Subsection2)
In your example you could use the hiearchy feature of robodoc to assign the variables to a function:
/****f* project/myfunction
....
/****/
/****v* myfunction/var1
....
/****/
or something similar.
The links are created by the header definitions (/****f* project/myfunction)
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Hope I'm not wearing out my welcome with a bunch of questions at once! :o
So when I do a header like:
/****f* Section/Subsection
That makes the function a section to itself.
I'd like to then be able to document the variables as part of the same section. However, the only way I know how to do this would be to:
/****v* Section/ThisVariable
Also, what makes the links in the source work? Is it the Section/Subsection Definition? Or a "NAME" tag?
Thanks!
-Brett
If you define a header (/****f* Section/Subsection) it will appear as a section or even a separate file (--one_file_per_header).
If you wish to document multiple objects in one header you can assign multiple names to one header, altough they will have the same header type. (/****f* Section/Subsection1, Subsection2)
In your example you could use the hiearchy feature of robodoc to assign the variables to a function:
/****f* project/myfunction
....
/****/
/****v* myfunction/var1
....
/****/
or something similar.
The links are created by the header definitions (/****f* project/myfunction)