This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

[PATCH] Doxygenate gdbtypes.h


Since minsyms.h and utils.h are churning a bit, I turned my attention to
gdbtypes.h.  As with defs.h, I've done only minimal content change,
although the patch looks large because of many unavoidable paragraph
refills.

I added an additional block comment at the top that is a bit of general
discussion, similar to content that was in gdbint.texinfo.  Doxygen
starts to win for us here, as not only does it create a separate page
for this block, but mentions of symbols become links to definitions and
detailed documentation.

I'll push this in a few days.

Stan
stan@codesourcery.com

2014-03-03  Stan Shebs  <stan@codesourcery.com>

	* gdbtypes.h: Annotate comments for Doxygen, add a page
	block comment with some general info.

	[doc/ChangeLog]
	* Doxyfile-gdb-api.in (INPUT): Add gdbtypes.h.

Attachment: gdbtypes-patch-1
Description: Text document


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]