hotlinexpress wrote: ... > /*! > * > * @param arg1 > * @param arg2 > * @return > */ > extern int test_func(int arg1, double arg2); > > It was my expectation that I could get Doxygen to generate a > warning when encountering a situation where the @param [arg1, > arg2] and @return keywords are present, but there is no > description for either parameter or the return. It was my > expectation that setting either the WARN_IF_DOC_ERROR or > WARN_NO_PARAMDOC, or the combination of the two, to YES, > would generate a warning in this case, but that seems not to > be happening. ...
I am not the developer so I can't say what was intended, but it seems to me that your example shows explicitly blank documentation for the parameters and return. That is: I would not have expected a warning in this situation. If either of the @param or @return lines were missing then, yes, a warning, but when they are present is appears that the writer wants them to be blank. Of course I can see your problem. Eclipse is placing these there ready for you to fill them in so it would be easy to miss entering text. Perhaps you could create an enhancement request to ask for the warning to include explicitly blank text - but where does that leave people who have nothing to say? At the moment they can prevent the warning by placing the line and leaving it blank, what can they do otherwise? Curious side note: I did not see your example comment block and declaration (or the configuration options) in my email from the list - I had to click on the nabble link to see what it was. I don't know why that is. -- Geoff Worboys Telesis Computing Pty Ltd ------------------------------------------------------------------------------ How ServiceNow helps IT people transform IT departments: 1. A cloud service to automate IT design, transition and operations 2. Dashboards that offer high-level views of enterprise services 3. A single system of record for all IT processes http://p.sf.net/sfu/servicenow-d2d-j _______________________________________________ Doxygen-users mailing list Doxygen-users@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/doxygen-users
