diff --git a/Doxyfile b/Doxyfile index 828da77e..d5b10f66 100644 --- a/Doxyfile +++ b/Doxyfile @@ -9,6 +9,7 @@ PROJECT_BRIEF = "C API providing common utilities and data structures." #STRIP_FROM_PATH = /Users/william/ros2_ws/install_isolated/rcutils/include # Otherwise just generate for the local (non-generated header files) INPUT = README.md ./include +EXCLUDE_PATTERNS = */stdatomic_helper/* USE_MDFILE_AS_MAINPAGE = README.md RECURSIVE = YES OUTPUT_DIRECTORY = doc_output diff --git a/include/rcutils/allocator.h b/include/rcutils/allocator.h index aac12d33..b6c76ba6 100644 --- a/include/rcutils/allocator.h +++ b/include/rcutils/allocator.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__ALLOCATOR_H_ #define RCUTILS__ALLOCATOR_H_ diff --git a/include/rcutils/cmdline_parser.h b/include/rcutils/cmdline_parser.h index dafa1bd4..1cf9a262 100644 --- a/include/rcutils/cmdline_parser.h +++ b/include/rcutils/cmdline_parser.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__CMDLINE_PARSER_H_ #define RCUTILS__CMDLINE_PARSER_H_ diff --git a/include/rcutils/env.h b/include/rcutils/env.h index 61879ef7..b82b3e0c 100644 --- a/include/rcutils/env.h +++ b/include/rcutils/env.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__ENV_H_ #define RCUTILS__ENV_H_ diff --git a/include/rcutils/error_handling.h b/include/rcutils/error_handling.h index 9d72e473..23e84fa7 100644 --- a/include/rcutils/error_handling.h +++ b/include/rcutils/error_handling.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__ERROR_HANDLING_H_ #define RCUTILS__ERROR_HANDLING_H_ diff --git a/include/rcutils/filesystem.h b/include/rcutils/filesystem.h index 6839f112..20dd2c7c 100644 --- a/include/rcutils/filesystem.h +++ b/include/rcutils/filesystem.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__FILESYSTEM_H_ #define RCUTILS__FILESYSTEM_H_ diff --git a/include/rcutils/find.h b/include/rcutils/find.h index d0c8d4ca..4569a935 100644 --- a/include/rcutils/find.h +++ b/include/rcutils/find.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__FIND_H_ #define RCUTILS__FIND_H_ diff --git a/include/rcutils/get_env.h b/include/rcutils/get_env.h index d08045eb..381f3de5 100644 --- a/include/rcutils/get_env.h +++ b/include/rcutils/get_env.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__GET_ENV_H_ #define RCUTILS__GET_ENV_H_ diff --git a/include/rcutils/isalnum_no_locale.h b/include/rcutils/isalnum_no_locale.h index 1bc1a51c..052ad53e 100644 --- a/include/rcutils/isalnum_no_locale.h +++ b/include/rcutils/isalnum_no_locale.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__ISALNUM_NO_LOCALE_H_ #define RCUTILS__ISALNUM_NO_LOCALE_H_ diff --git a/include/rcutils/logging.h b/include/rcutils/logging.h index 395065f6..851b9072 100644 --- a/include/rcutils/logging.h +++ b/include/rcutils/logging.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__LOGGING_H_ #define RCUTILS__LOGGING_H_ diff --git a/include/rcutils/macros.h b/include/rcutils/macros.h index a70d1398..f54fb0db 100644 --- a/include/rcutils/macros.h +++ b/include/rcutils/macros.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__MACROS_H_ #define RCUTILS__MACROS_H_ diff --git a/include/rcutils/process.h b/include/rcutils/process.h index dc07f6a9..e1bf6e07 100644 --- a/include/rcutils/process.h +++ b/include/rcutils/process.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__PROCESS_H_ #define RCUTILS__PROCESS_H_ diff --git a/include/rcutils/qsort.h b/include/rcutils/qsort.h index 9e71ffc2..9af8904a 100644 --- a/include/rcutils/qsort.h +++ b/include/rcutils/qsort.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__QSORT_H_ #define RCUTILS__QSORT_H_ diff --git a/include/rcutils/repl_str.h b/include/rcutils/repl_str.h index a9411ff5..a080b7d1 100644 --- a/include/rcutils/repl_str.h +++ b/include/rcutils/repl_str.h @@ -23,7 +23,7 @@ // It has been modified to take a custom allocator and to fit some of our // style standards. -/// @file +/// \file #ifndef RCUTILS__REPL_STR_H_ #define RCUTILS__REPL_STR_H_ diff --git a/include/rcutils/shared_library.h b/include/rcutils/shared_library.h index 525d8e5d..996e0855 100644 --- a/include/rcutils/shared_library.h +++ b/include/rcutils/shared_library.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__SHARED_LIBRARY_H_ #define RCUTILS__SHARED_LIBRARY_H_ diff --git a/include/rcutils/snprintf.h b/include/rcutils/snprintf.h index 8e0ca3a8..53a10201 100644 --- a/include/rcutils/snprintf.h +++ b/include/rcutils/snprintf.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__SNPRINTF_H_ #define RCUTILS__SNPRINTF_H_ diff --git a/include/rcutils/split.h b/include/rcutils/split.h index 6c5e7c6f..ec62f772 100644 --- a/include/rcutils/split.h +++ b/include/rcutils/split.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__SPLIT_H_ #define RCUTILS__SPLIT_H_ diff --git a/include/rcutils/strcasecmp.h b/include/rcutils/strcasecmp.h index 01d5f3af..8b03ed34 100644 --- a/include/rcutils/strcasecmp.h +++ b/include/rcutils/strcasecmp.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__STRCASECMP_H_ #define RCUTILS__STRCASECMP_H_ diff --git a/include/rcutils/strdup.h b/include/rcutils/strdup.h index 098d8d10..7c6b1d78 100644 --- a/include/rcutils/strdup.h +++ b/include/rcutils/strdup.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__STRDUP_H_ #define RCUTILS__STRDUP_H_ diff --git a/include/rcutils/strerror.h b/include/rcutils/strerror.h index ca000cc3..a3a900a9 100644 --- a/include/rcutils/strerror.h +++ b/include/rcutils/strerror.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__STRERROR_H_ #define RCUTILS__STRERROR_H_ diff --git a/include/rcutils/time.h b/include/rcutils/time.h index d8c9f234..bff3e41a 100644 --- a/include/rcutils/time.h +++ b/include/rcutils/time.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__TIME_H_ #define RCUTILS__TIME_H_ diff --git a/include/rcutils/types/array_list.h b/include/rcutils/types/array_list.h index c2d6a2c7..ffde41a2 100644 --- a/include/rcutils/types/array_list.h +++ b/include/rcutils/types/array_list.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__TYPES__ARRAY_LIST_H_ #define RCUTILS__TYPES__ARRAY_LIST_H_ diff --git a/include/rcutils/types/char_array.h b/include/rcutils/types/char_array.h index 24ca593b..a0d64f04 100644 --- a/include/rcutils/types/char_array.h +++ b/include/rcutils/types/char_array.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__TYPES__CHAR_ARRAY_H_ #define RCUTILS__TYPES__CHAR_ARRAY_H_ diff --git a/include/rcutils/types/hash_map.h b/include/rcutils/types/hash_map.h index 572c7855..2c22e0bb 100644 --- a/include/rcutils/types/hash_map.h +++ b/include/rcutils/types/hash_map.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__TYPES__HASH_MAP_H_ #define RCUTILS__TYPES__HASH_MAP_H_ diff --git a/include/rcutils/types/rcutils_ret.h b/include/rcutils/types/rcutils_ret.h index 418f9531..b4712d2b 100644 --- a/include/rcutils/types/rcutils_ret.h +++ b/include/rcutils/types/rcutils_ret.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__TYPES__RCUTILS_RET_H_ #define RCUTILS__TYPES__RCUTILS_RET_H_ diff --git a/include/rcutils/types/string_array.h b/include/rcutils/types/string_array.h index 8b312fc4..4c4c97e9 100644 --- a/include/rcutils/types/string_array.h +++ b/include/rcutils/types/string_array.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__TYPES__STRING_ARRAY_H_ #define RCUTILS__TYPES__STRING_ARRAY_H_ diff --git a/include/rcutils/types/string_map.h b/include/rcutils/types/string_map.h index 39516700..49b65fdb 100644 --- a/include/rcutils/types/string_map.h +++ b/include/rcutils/types/string_map.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__TYPES__STRING_MAP_H_ #define RCUTILS__TYPES__STRING_MAP_H_ diff --git a/include/rcutils/types/uint8_array.h b/include/rcutils/types/uint8_array.h index bdd6cec7..215e9384 100644 --- a/include/rcutils/types/uint8_array.h +++ b/include/rcutils/types/uint8_array.h @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/// @file +/// \file #ifndef RCUTILS__TYPES__UINT8_ARRAY_H_ #define RCUTILS__TYPES__UINT8_ARRAY_H_