This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.
| Summary: | *Doxygen*: 'No documentation found' for module.GetUnits in Quote | ||
|---|---|---|---|
| Product: | cnd | Reporter: | dnikitin <dnikitin> |
| Component: | -- Other -- | Assignee: | Thomas Preisler <thp> |
| Status: | RESOLVED INVALID | ||
| Severity: | normal | ||
| Priority: | P3 | ||
| Version: | 6.x | ||
| Hardware: | PC | ||
| OS: | All | ||
| Issue Type: | DEFECT | Exception Reporter: | |
| Attachments: | documentation is not shown in popup dialog | ||
It is actually not a bug. Common practice is to put Doxygen documentation in the header file where the declaration is and not in the source file where the implementation is. The reason is the header file is viewed by the user where as the source usually is not. So, add you comments in module.h just before GetUnit and it works just fine when code complete GetUnit. Will close as INVALID but I will ask Vladimir V to see if he has any comments. We could probably also look where the function is implemented but it raises some issues with what if it is documented both places. Which one do you prefer? Vladimir, please comment and reopen if you think we should also look where the function is implemented. Thomas, you are right. doxygen documentation is applied to declarations not impl. Btw, doxygen tool would not generate such documentation as well. |
Created attachment 96619 [details] documentation is not shown in popup dialog Product Version: NetBeans IDE Dev (Build cnd-main-3127-on-100329) Java: 1.6.0_16; Java HotSpot(TM) Client VM 14.2-b01 System: Linux version 2.6.28-18-generic running on i386; UTF-8; en_US (nb) ------------------------------------------------------------------ -- add module.cc in Quote sample project -- add doxygen command for GetUnits() -- find line output << "Number of sub-modules: " << module.GetUnits() << endl; -- invoke code completion for GetUnits ==> pop-up dialog shows 'No documentation found' (see attachment)