mirrors/binutils-gdb
0
0
Fork 0
mirror of https://sourceware.org/git/binutils-gdb.git synced 2024-11-27 03:54:41 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Automatic link generation by doxygen

Browse Source 
Nowadays, we have one page on "GDB Types" generated by doxygen, but types
and macros referenced in doc are not linked to their definitions.  This
patch tweaks the comments a little to use doxygen syntax so that these
types and macros are linked their definitions.

Is it OK?

gdb:

2014-04-17  Yao Qi  <yao@codesourcery.com>

	* gdbtypes.h: Update comments to link to types and macros'
	definitions.
This commit is contained in:
Yao Qi 2014-03-13 14:07:26 +08:00
parent 1568481a55
commit 71e50e8314
2 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
gdb/ChangeLog
View File

@ -1,3 +1,8 @@
2014-04-17 Yao Qi <yao@codesourcery.com>
* gdbtypes.h: Update comments to link to types and macros'
definitions.
2014-04-16 Siva Chandra Reddy <sivachandra@google.com>
* gdbtypes.h: Remove definition of the macro TYPE_FN_FIELDS.

15
gdb/gdbtypes.h
View File

@ -29,18 +29,19 @@
languages using a common representation defined in gdbtypes.h.
The main data structure is main_type; it consists of a code (such
as TYPE_CODE_ENUM for enumeration types), a number of
as #TYPE_CODE_ENUM for enumeration types), a number of
generally-useful fields such as the printable name, and finally a
field type_specific that is a union of info specific to particular
languages or other special cases (such as calling convention).
field main_type::type_specific that is a union of info specific to
particular languages or other special cases (such as calling
convention).
The available type codes are defined in enum type_code. The enum
The available type codes are defined in enum #type_code. The enum
includes codes both for types that are common across a variety
of languages, and for types that are language-specific.
Most accesses to type fields go through macros such as TYPE_CODE
and TYPE_FN_FIELD_CONST. These are written such that they can be
used as both rvalues and lvalues.
Most accesses to type fields go through macros such as
#TYPE_CODE(thistype) and #TYPE_FN_FIELD_CONST(thisfn, n). These are
written such that they can be used as both rvalues and lvalues.
*/
#include "hashtab.h"