Skip to content

Commit 98cda42

Browse files
committed
Shortened a couple of link id strings (these identifiers
are for doxygen, not seen in doxygen output). modified: doc/libdwarf.dox And in addtion to using the new link identifier fixed a couple of words in doxygen comments that were misspelled. modified: src/lib/libdwarf/libdwarf.h
1 parent e58053b commit 98cda42

File tree

2 files changed

+26
-27
lines changed

2 files changed

+26
-27
lines changed

doc/libdwarf.dox

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@
243243
That's all there is to it.
244244

245245

246-
@section dwsec_linetableregisters Line Table Registers
246+
@section dwsec_linetabreg Line Table Registers
247247

248248
Line Table Registers
249249

@@ -273,7 +273,7 @@
273273
discriminator
274274
@endcode
275275

276-
@section dwsec_independentsections Reading Special Sections Independently
276+
@section dwsec_independentsec Reading Special Sections Independently
277277

278278
Reading a particular set of special sections
279279

src/lib/libdwarf/libdwarf.h

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3456,7 +3456,7 @@ DW_API int dwarf_srclines_version(Dwarf_Line_Context dw_line_context,
34563456

34573457
/*! @brief Read Line beginstatement register
34583458
3459-
@link dwsec_linetableregisters Link to Line Table Registers @endlink
3459+
@link dwsec_linetabreg Link to Line Table Registers @endlink
34603460
34613461
@param dw_line
34623462
The Dwarf_Line of interest.
@@ -3475,7 +3475,7 @@ DW_API int dwarf_linebeginstatement(Dwarf_Line dw_line,
34753475

34763476
/*! @brief Read Line endsequence register flag
34773477
3478-
@link dwsec_linetableregisters Link to Line Table Registers @endlink
3478+
@link dwsec_linetabreg Link to Line Table Registers @endlink
34793479
34803480
@param dw_line
34813481
The Dwarf_Line of interest.
@@ -3494,7 +3494,7 @@ DW_API int dwarf_lineendsequence(Dwarf_Line dw_line,
34943494

34953495
/*! @brief Read Line line register
34963496
3497-
@link dwsec_linetableregisters Link to Line Table Registers @endlink
3497+
@link dwsec_linetabreg Link to Line Table Registers @endlink
34983498
34993499
@param dw_line
35003500
The Dwarf_Line of interest.
@@ -3512,7 +3512,7 @@ DW_API int dwarf_lineno(Dwarf_Line dw_line,
35123512

35133513
/*! @brief Read Line file register
35143514
3515-
@link dwsec_linetableregisters Link to Line Table Registers @endlink
3515+
@link dwsec_linetabreg Link to Line Table Registers @endlink
35163516
35173517
@param dw_line
35183518
The Dwarf_Line of interest.
@@ -3547,7 +3547,7 @@ DW_API int dwarf_line_is_addr_set(Dwarf_Line dw_line,
35473547

35483548
/*! @brief Returns the address of the Dwarf_Line
35493549
3550-
@link dwsec_linetableregisters Link to Line Table Registers @endlink
3550+
@link dwsec_linetabreg Link to Line Table Registers @endlink
35513551
35523552
@param dw_line
35533553
The Dwarf_Line of interest.
@@ -3565,7 +3565,7 @@ DW_API int dwarf_lineaddr(Dwarf_Line dw_line,
35653565

35663566
/*! @brief Returns a column number through the pointer
35673567
3568-
@link dwsec_linetableregisters Link to Line Table Registers @endlink
3568+
@link dwsec_linetabreg Link to Line Table Registers @endlink
35693569
35703570
@param dw_line
35713571
The Dwarf_Line of interest.
@@ -3583,7 +3583,7 @@ DW_API int dwarf_lineoff_b(Dwarf_Line dw_line,
35833583

35843584
/*! @brief Return the file name applicable to the Dwarf_Line
35853585
3586-
@link dwsec_linetableregisters Link to Line Table Registers @endlink
3586+
@link dwsec_linetabreg Link to Line Table Registers @endlink
35873587
35883588
@param dw_line
35893589
The Dwarf_Line of interest.
@@ -3604,7 +3604,7 @@ DW_API int dwarf_linesrc(Dwarf_Line dw_line,
36043604

36053605
/*! @brief Returns the basic_block line register.
36063606
3607-
@link dwsec_linetableregisters Link to Line Table Registers @endlink
3607+
@link dwsec_linetabreg Link to Line Table Registers @endlink
36083608
36093609
@param dw_line
36103610
The Dwarf_Line of interest.
@@ -3624,7 +3624,7 @@ DW_API int dwarf_lineblock(Dwarf_Line dw_line,
36243624
will want all or none of them. */
36253625
/*! @brief Returns various line table registers in one call
36263626
3627-
@link dwsec_linetableregisters Link to Line Table Registers @endlink
3627+
@link dwsec_linetabreg Link to Line Table Registers @endlink
36283628
36293629
@param dw_line
36303630
The Dwarf_Line of interest.
@@ -5514,7 +5514,7 @@ DW_API Dwarf_Half dwarf_set_frame_undefined_value(
55145514
/*! @defgroup abbrev Abbreviations .debug_abbrev Section Details
55155515
Allows reading .debug_abbrev independently of CUs or DIEs.
55165516
5517-
@link dwsec_independentsections About Reading Independently. @endlink
5517+
@link dwsec_independentsec About Reading Independently. @endlink
55185518
@{
55195519
*/
55205520
/*! @brief Reading Abbreviation Data
@@ -5662,7 +5662,7 @@ DW_API int dwarf_get_abbrev_entry_b(Dwarf_Abbrev dw_abbrev,
56625662
*/
56635663
/*! @brief Reading From a String Section
56645664
5665-
@link dwsec_independentsections Reading The String Section @endlink
5665+
@link dwsec_independentsec Reading The String Section @endlink
56665666
56675667
@param dw_dbg
56685668
The Dwarf_Debug whose .debug_str section we want to access.
@@ -5694,7 +5694,7 @@ DW_API int dwarf_get_str(Dwarf_Debug dw_dbg,
56945694
Most library users will never call these,
56955695
as references to this is handled by the code
56965696
accessing some Dwarf_Attribute.
5697-
@link dwsec_independentsections Reading The Str_Offsets @endlink
5697+
@link dwsec_independentsec Reading The Str_Offsets @endlink
56985698
@{
56995699
*/
57005700
/* Allows applications to print the .debug_str_offsets
@@ -5890,7 +5890,7 @@ DW_API char* dwarf_errmsg_by_number(Dwarf_Unsigned dw_errornum);
58905890
DW_API void dwarf_error_creation(Dwarf_Debug dw_dbg ,
58915891
Dwarf_Error * dw_error, char * dw_errmsg);
58925892

5893-
/*! @brief Free (dealloc) an Dwarf_Error somethimg created.
5893+
/*! @brief Free (dealloc) an Dwarf_Error something created.
58945894
@param dw_dbg
58955895
The relevant Dwarf_Debug pointer.
58965896
@param dw_error
@@ -6243,7 +6243,7 @@ DW_API int dwarf_dnames_name(Dwarf_Dnames_Head dw_dn,
62436243
/*! @brief Find an abbrev set by abbrev code
62446244
62456245
Useful for a quick look at what an abbrev record contains.
6246-
6246+
62476247
@param dw_dn
62486248
Pass in the debug names table of interest.
62496249
@param dw_abbrev_code
@@ -6259,10 +6259,10 @@ DW_API int dwarf_dnames_name(Dwarf_Dnames_Head dw_dn,
62596259
The numbers are sequential, 0,1, etc.
62606260
The trailing 0,0 pair is counted.
62616261
@param dw_number_of_attr_form_entries
6262-
If non-null and the call succeeds, number of
6262+
If non-null and the call succeeds, the number of
62636263
attribute-form pairs in this abbrev is returned.
6264-
The count includes the terminationg 0,0 pair.
6265-
@return
6264+
The count includes the terminating 0,0 pair.
6265+
@return
62666266
Returns either DW_DLV_OK or, if the abbrev code is
62676267
not found, returns DW_DLV_NO_ENTRY.
62686268
*/
@@ -6294,7 +6294,7 @@ DW_API int dwarf_dnames_abbrev_by_code(Dwarf_Dnames_Head dw_dn,
62946294
@return
62956295
DW_DLV_OK is returned if the specified entry exists.
62966296
DW_DLV_NO_ENTRY is returned if the specified indexes
6297-
do not designate an entry (an index out of range).
6297+
do not designate an entry (an index out of range).
62986298
DW_DLV_ERROR is returned in case of an internal error
62996299
or corrupt section content.
63006300
*/
@@ -6308,17 +6308,17 @@ DW_API int dwarf_dnames_abbrev_form_by_index(Dwarf_Dnames_Head dw_dn,
63086308
/*! @brief Returns a the set of values from an entrypool entry
63096309
63106310
Returns the basic data about an entrypool record
6311-
and enables correct calling of
6311+
and enables correct calling of
63126312
dwarf_dnames_entrypool_values
63136313
(see below). The two-stage approach makes it
63146314
simple for callers to prepare for the number of
6315-
values that will be returned by
6315+
values that will be returned by
63166316
dwarf_dnames_entrypool_values()
63176317
63186318
@param dw_dn
63196319
Pass in the debug names table of interest.
63206320
@param dw_offset_in_entrypool
6321-
The record offset (in the entry pool table)
6321+
The record offset (in the entry pool table)
63226322
of the first record of IDX attributes. Starts at zero.
63236323
@param dw_abbrev_code
63246324
On success returns the abbrev code of the idx attributes
@@ -6328,7 +6328,7 @@ DW_API int dwarf_dnames_abbrev_form_by_index(Dwarf_Dnames_Head dw_dn,
63286328
by this entrypool entry.
63296329
@param dw_value_count
63306330
On success returns the number of distinct
6331-
values imply by this entry.
6331+
values imply by this entry.
63326332
@param dw_index_of_abbrev
63336333
On success returns the index of the abbrev index/form
63346334
pairs in the abbreviation table.
@@ -6394,7 +6394,7 @@ DW_API int dwarf_dnames_entrypool(Dwarf_Dnames_Head dw_dn,
63946394
long, and pass a pointer to the first entry here.
63956395
@param dw_offset_of_next_entrypool
63966396
On success returns the offset of the next entrypool.
6397-
A value here is usable in the next call to
6397+
A value here is usable in the next call to
63986398
dwarf_dnames_entrypool.
63996399
@param dw_single_cu
64006400
On success, if it is a single-cu name table there is
@@ -6427,7 +6427,6 @@ DW_API int dwarf_dnames_entrypool_values(Dwarf_Dnames_Head dw_dn,
64276427
Dwarf_Unsigned *dw_offset_of_next_entrypool,
64286428
Dwarf_Error *dw_error);
64296429

6430-
64316430
/*! @} */
64326431

64336432
/*! @defgroup aranges Fast Access-Access to a CU given a code address
@@ -7583,7 +7582,7 @@ DW_API int dwarf_add_debuglink_global_path(Dwarf_Debug dw_dbg,
75837582
75847583
@param dw_dbg
75857584
Pass in an open dw_dbg. When you attempted
7586-
to open it, and it succeded then pass the
7585+
to open it, and it succeeded then pass the
75877586
it via the Dwarf_Debug
75887587
The function reads the file into memory
75897588
and performs a crc calculation.

0 commit comments

Comments
 (0)