Documenting conceptual functions
"Zieg, Mark (KSC-ESC-624)[SGT - ESC]" <[email protected]>
| Newsgroups | gmane.text.doxygen.general |
|---|---|
| Message-ID | <[email protected]> |
Hi, Sorry if this has been documented elsewhere, but it's a hard thing to Google for. I have a C++ application which exposes a service over an API. I already use Doxygen to render lovely maintenance documentation for the server application itself. However, I'd also like to use Doxygen to render structured documentation for the API which my server exposes, and here I'm a little confused. I don't actually have source code for the API "methods," "parameters" and "return values," because client requests are parsed internally by my server as text -- there are no compiled signatures for Doxygen to process. I know Doxygen has keywords like @brief, @param and @return to document functions. Is there something like @function to create a "fake function" that those keywords can then decorate? I tried using @fn, but got "Warning: documented function was not declared or defined," and no documentation was generated. (PS, I know I could create a "fake" C++ header file, but I was hoping not to.) Thanks for your suggestions. ------------------------------------------------------------------------------ Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ Doxygen-users mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/doxygen-users