Skip to content

Commit 753834b

Browse files
i#7796 doxygen: Fix quote character parsing issues (#7828)
Escapes quote characters in three places in doxygen comments to avoid errors from doxygen 1.15. Removes a stray backtick left in the middle of building.dox which caused parsing errors. Some enum class link errors remain for 1.15; work on those is still in progress. Issue: #7796
1 parent ac5298b commit 753834b

File tree

4 files changed

+8
-9
lines changed

4 files changed

+8
-9
lines changed

api/docs/building.dox

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* ******************************************************************************
2-
* Copyright (c) 2010-2025 Google, Inc. All rights reserved.
2+
* Copyright (c) 2010-2026 Google, Inc. All rights reserved.
33
* ******************************************************************************/
44

55
/*
@@ -444,7 +444,6 @@ In order to build the documentation, you will additionally need:
444444
- doxygen
445445

446446
These can be either Cygwin packages or native Windows.
447-
TH`.
448447

449448
\subsection sec_build_windows_cygwin Using Cygwin
450449

core/lib/dr_config.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* **********************************************************
2-
* Copyright (c) 2011-2025 Google, Inc. All rights reserved.
2+
* Copyright (c) 2011-2026 Google, Inc. All rights reserved.
33
* Copyright (c) 2008-2010 VMware, Inc. All rights reserved.
44
* **********************************************************/
55

@@ -188,7 +188,7 @@ typedef struct _dr_config_client_t {
188188
* A NULL-terminated string specifying the full path to a valid client library.
189189
* The string length cannot exceed #MAXIMUM_PATH. The client path may not
190190
* include any semicolons and when combined with \p client_options may not
191-
* include all three quote characters (', ", `) simultaneously.
191+
* include all three quote characters (\', \", \`) simultaneously.
192192
*
193193
* When querying via dr_get_client_info_ex() or dr_client_iterator_next_ex(), the
194194
* caller must either set this to NULL if that data is not needed or point at a
@@ -200,7 +200,7 @@ typedef struct _dr_config_client_t {
200200
* as arguments of dr_client_main() or via dr_get_option_array(). The string
201201
* length cannot exceed #DR_MAX_OPTIONS_LENGTH. The client options may not
202202
* include any semicolons and when combined with \p client_path may not include
203-
* all three quote characters (', ", `) simultaneously.
203+
* all three quote characters (\', \", \`) simultaneously.
204204
*
205205
* When querying via dr_get_client_info_ex() or dr_client_iterator_next_ex(), the
206206
* caller must either set this to NULL if that data is not needed or point at a

core/lib/dr_inject.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* **********************************************************
2-
* Copyright (c) 2013-2025 Google, Inc. All rights reserved.
2+
* Copyright (c) 2013-2026 Google, Inc. All rights reserved.
33
* Copyright (c) 2010 VMware, Inc. All rights reserved.
44
* **********************************************************/
55

@@ -114,7 +114,7 @@ DR_EXPORT
114114
* this process.
115115
* \param[out] app_name Pointer to the name of the target process.
116116
* Only valid until dr_inject_process_exit.
117-
* \return Returns 0 on success. On failure, returns a system error code.`
117+
* \return Returns 0 on success. On failure, returns a system error code.
118118
*/
119119
int
120120
dr_inject_process_attach(process_id_t pid, void **data, char **app_name);

core/lib/dr_tools.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* **********************************************************
2-
* Copyright (c) 2010-2025, Inc. All rights reserved.
2+
* Copyright (c) 2010-2026, Inc. All rights reserved.
33
* Copyright (c) 2002-2010 VMware, Inc. All rights reserved.
44
* **********************************************************/
55

@@ -1939,7 +1939,7 @@ DR_API
19391939
* continues (including across whitespace) until the matching end
19401940
* quote is found. Characters considered whitespace are ' ', '\\t',
19411941
* '\\r', and '\\n'; characters considered quotes are '\\'', '\\"', and
1942-
* '`'.
1942+
* '\`'.
19431943
*
19441944
* @param[in] str The start of the string containing the next token.
19451945
* @param[out] buf A buffer to store a null-terminated copy of the next token.

0 commit comments

Comments
 (0)