C function prototypes and definitions
Multi-language source code documentation tool
Brought to you by:
gregvalure
Menu
▾
▴
If there is a C function f, documented as:
// File f.h
// Function: f
// Does something.
int f();
// File f.c
// Function: f
// Does something. Detailed description
Then, how is this handled? Where do links to <f> point, and will the index have just one reference for f()?
The index will have an entry for f broken out by file. <f> will always link to the one within its own file first. One definition will be chosen for all documentation outside of those files, but which one is arbitrary.
1.4 will be able to combine the documentation from headers and source files; it's what's been holding back full language support for C/C++. You may want to choose to document a particular function in either the header or the source file because I don't know how I'm handling them both having documentation yet. Just the topic so it shows up in the output is fine.
Do you have a timeline for the 1.4 release? I'd love to the ND full support for my weapon of choice (C/C++)!!
Nope. It's done when it's done. I'm working on it now, but it's early and there's a lot more than just C++ support going into it.