diff options
| author | Yao Qi <yao@codesourcery.com> | 2014-03-13 14:07:26 +0800 |
|---|---|---|
| committer | Yao Qi <yao@codesourcery.com> | 2014-04-17 10:03:05 +0800 |
| commit | 71e50e8314af251f153207192194eaffdf638f5e (patch) | |
| tree | ef684b4c6db70a03f262051072d772d0dc873cb3 | |
| parent | 1568481a553b0071c397e6d5d79a8cae4133485b (diff) | |
| download | binutils-gdb-71e50e8314af251f153207192194eaffdf638f5e.tar.gz | |
Automatic link generation by doxygen
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.
| -rw-r--r-- | gdb/ChangeLog | 5 | ||||
| -rw-r--r-- | gdb/gdbtypes.h | 15 |
2 files changed, 13 insertions, 7 deletions
diff --git a/gdb/ChangeLog b/gdb/ChangeLog index 2f56df30cea..e8cdd1423a4 100644 --- a/gdb/ChangeLog +++ b/gdb/ChangeLog @@ -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. diff --git a/gdb/gdbtypes.h b/gdb/gdbtypes.h index dc1aa90e8ff..86b1d629f44 100644 --- a/gdb/gdbtypes.h +++ b/gdb/gdbtypes.h @@ -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" |