GNOME Bugzilla – Bug 539891
Can't use doxygen commands in *_override.xml
Last modified: 2008-09-29 21:55:04 UTC
DocParser.pm's convert_tags_to_doxygen() converts all @something to @a something, breaking, for instance, @throw and @param. See: http://svn.gnome.org/viewvc/glibmm/trunk/tools/pm/DocsParser.pm?view=markup Someone with enough perl expertise needs to stop it from doing that. Alternatively, we could add a no_docs option to _WRAP_METHOD() and just put the documentation in the .hg file.
The line in question is 355, as seen in the annotation: http://svn.gnome.org/viewvc/glibmm/trunk/tools/pm/DocsParser.pm?annotate=676 I don't have enough context to know what to change it to, however. It seems that its designed to be translating gtkdoc style var references to doxygen style var references, but if it is translating things like @throw and @param, that would indicate this function is being run on files it shouldn't be running on? Given the limited context, it could be possible to blacklist that substitution from running given certain keywords, but that may not be the best solution.
Yes, that's the line. > It seems that its designed to be translating gtkdoc style var references to doxygen style var references, but if it is translating things like @throw and @param, that would indicate this function is being run on files it shouldn't be running on? We want the *_docs_overrides.xml file to be as much like the *_docs.xml (C documentation) files as possible, with only small changes where necessary. I suppose we could stop this function from running on the *_docs_overrides.xml files, but then we would have to go through those files and manually convert them all from gtk-doc to doxygen syntax.
Created attachment 118999 [details] [review] Proposed patch This is a very simple, but working, patch.
Thanks. Sorry for not seeing this until now.