Re: [Doxygen-users] C++ cast operator, 1.8.4 to 1.8.5 changes and maybe a feature request
Brought to you by:
dimitri
From: liam m. <lia...@go...> - 2013-11-02 14:56:55
|
On 2 November 2013 14:30, liam mail <lia...@go...> wrote: > Couple of questions: > - How can you reference a cast operator which is a member function of a > C++ class? > - Has there been changes in how parameters are handled between 1.8.4 and > 1.8.5? I could not see anything in the changelog about this. In 1.8.4 I was > using Doxygen to document Lua code as if it was a build in language, this > required a few changes just for docs although it did work. For a Lua > functions documented as the following it produced correct parameter details > \fn function gen(options, path) > \param options [optional] Defaults to the library \ref defaults > \param path [optional] Defaults to the current working directory > \brief Generate boilerplate header files > \details Generates boilerplate C++ files code required for OOLua > using the passed options > or if an option is not present then the default is used. If Path > is not nil then it is > required to be a string which is slash postfixed. > Yet in 1.8.5 it no longer generates correct parameter documentation, > instead it places the param documentation verbatim. I have tried removing > [optional] to see if that was the problem, yet it had no effect. > - Is there an keyword I can use so that the library does not warn about > something Doxygen finds at a specific location? I am abusing the library > documenting macros which take __VA_ARGS__ as if they take named parameters > and the output is cluttered with warnings, which makes it difficult to pick > out genuine problems. I could write a script to strip some of these from > the log but it would be nice if there was some keyword for this, in a > similar manner to //NOLINT. > > Thanks > --Liam > Sorry I should have provided this information. Whilst the version is reported as 1.8.5 the code is pulled from the github repo and I have seen the stackoverflow question and bug report [1] The Lua code which is being documented can be seen in its entirety at [2] and an example of the macro __VA_ARGS__ abuse can be seen at [3]. [1] https://bugzilla.gnome.org/show_bug.cgi?id=707431 [2] https://bitbucket.org/liamdevine/oolua/src/a736895db8e87058f7c4376aae20f17187bd993d/build_scripts/oolua_generate.lua?at=OOLua-2 [3] https://bitbucket.org/liamdevine/oolua/src/c29b03fc3a3bb5f6497b1c20d5cb84ffe31feb9e/include/dsl_va_args.h?at=OOLua-2#cl-258 Thanks --Liam |