[Pidgin] #1442: Remove GNU boilerplate from Doxygen code
Pidgin
trac at pidgin.im
Wed May 30 19:49:34 EDT 2007
#1442: Remove GNU boilerplate from Doxygen code
-------------------------------------------+--------------------------------
Reporter: wehlhard | Owner:
Type: enhancement | Status: new
Priority: minor | Milestone:
Component: libpurple | Version: 2.0.1
Keywords: doxygen api boilerplate noise | Pending: 0
-------------------------------------------+--------------------------------
Currently, the GNU boilerplate text at the top of each header file is
placed such that Doxygen uses it as the "detailed description" for that
API component (example:
http://developer.pidgin.im/doxygen/dev/html/account_8h.html#_details ). I
find this very annoying.
As far as I know, there is no reason that the GPL boilerplate text needs
to be in the Doxygen documentation at all, especially not where one would
expect an overview of an API component.
This can be changed fairly trivially by ending the Doxygen API comment at
the top of the file as seen in the attachment. I can do this to trunk in
the next few days if no one objects.
--
Ticket URL: <http://developer.pidgin.im/ticket/1442>
Pidgin <http://pidgin.im>
Pidgin
More information about the Tracker
mailing list