Ticket #28 (closed enhancement: fixed)
Fill in doxygen in C api
| Reported by: | Peter Peterson | Owned by: | Unassigned |
|---|---|---|---|
| Priority: | major | Milestone: | NeXus 4.2 Ready |
| Component: | applications | Version: | |
| Keywords: | Cc: |
Description
The documentation should filled in for the C API for napi.h. The lower level documentation needs to be hidden by default.
Change History
comment:1 Changed 5 years ago by Freddie Akeroyd
- Owner set to Freddie Akeroyd
- Component set to applications
- Milestone changed from NeXus 4.1 Ready to NeXus 4.2 Ready
comment:3 Changed 4 years ago by Mark Koennecke
(In [977]) Added the doxygen documentation to napi.h, refs #28
Doxygen documentation for the NeXus C-APi can be built by issuing doxygen napidox at the root level of the distribution. The docs can then be found under doc/api/html/index.html.
The bulk of the work is done. There are still open issues:
- someone should proofread what I have done
- we might need to discuss formatting issues. Apparently doxygen allows many options.
comment:4 Changed 4 years ago by Freddie Akeroyd
Mark,
Happy new year and good work on the documentation.
I see you added a new Doxygen configuration file - did you miss the one in the doc/doxygen directory or was there a problem with it? This file is the one i use to automatically build the web help which is at
http://download.nexusformat.org/doxygen/html/
currently it adds in all the call graphs etc. and so is a bit long - we may want to change this or have several Doxygen config files to give brief and detailed help
Regards,
Freddie
comment:5 Changed 4 years ago by Mark Koennecke
Freddy,
sorry for the delay in reacting to this. If there is already a doxygen configuration I am happy for it to be used. I just did not know of it and needed one to test what I have done.
Regards,
Mark
