From c98fe933a491ba5ad9dfb29386946ae2470ecd70 Mon Sep 17 00:00:00 2001 From: Amar Takhar Date: Sat, 26 Sep 2009 09:38:17 +0000 Subject: [PATCH] Add @ingroup tags and another doxygen comment. Originally committed to SVN as r3558. --- aegisub/reporter/aegisub.cpp | 1 + aegisub/reporter/aegisub.h | 1 + aegisub/reporter/include/platform.h | 1 + aegisub/reporter/main.cpp | 1 + aegisub/reporter/main.h | 1 + aegisub/reporter/name_map.cpp | 1 + aegisub/reporter/platform.cpp | 1 + aegisub/reporter/platform_unix.cpp | 1 + aegisub/reporter/platform_unix.h | 1 + aegisub/reporter/platform_unix_bsd.cpp | 1 + aegisub/reporter/platform_unix_bsd.h | 1 + aegisub/reporter/progress.cpp | 1 + aegisub/reporter/progress.h | 1 + aegisub/reporter/r_pre.h | 1 + aegisub/reporter/report.cpp | 1 + aegisub/reporter/report.h | 1 + aegisub/reporter/sha256.c | 1 + aegisub/reporter/sha256.h | 5 +++++ aegisub/reporter/upload.cpp | 1 + aegisub/reporter/upload.h | 1 + aegisub/reporter/view.cpp | 1 + aegisub/reporter/view.h | 1 + 22 files changed, 26 insertions(+) diff --git a/aegisub/reporter/aegisub.cpp b/aegisub/reporter/aegisub.cpp index 033db3d7e..0b769d8dd 100644 --- a/aegisub/reporter/aegisub.cpp +++ b/aegisub/reporter/aegisub.cpp @@ -16,6 +16,7 @@ /// @file aegisub.cpp /// @brief Aegisub specific configuration options and properties. +/// @ingroup base #ifndef R_PRECOMP #include diff --git a/aegisub/reporter/aegisub.h b/aegisub/reporter/aegisub.h index f1eb2c073..59e5d3afa 100644 --- a/aegisub/reporter/aegisub.h +++ b/aegisub/reporter/aegisub.h @@ -16,6 +16,7 @@ /// @file aegisub.h /// @see aegisub.cpp +/// @ingroup base /// @class Aegisub /// @brief Gather Aegisub information from the config file or otherwise. diff --git a/aegisub/reporter/include/platform.h b/aegisub/reporter/include/platform.h index 88d0474a7..b3ab2eaeb 100644 --- a/aegisub/reporter/include/platform.h +++ b/aegisub/reporter/include/platform.h @@ -17,6 +17,7 @@ /// @file platform.h /// @brief API for gathering platform information. /// @see platform.cpp +/// @ingroup base #ifndef R_PRECOMP #include diff --git a/aegisub/reporter/main.cpp b/aegisub/reporter/main.cpp index 9d05db6e5..551da32f3 100644 --- a/aegisub/reporter/main.cpp +++ b/aegisub/reporter/main.cpp @@ -16,6 +16,7 @@ /// @file main.cpp /// @brief Main loop +/// @ingroup base #ifndef R_PRECOMP #include diff --git a/aegisub/reporter/main.h b/aegisub/reporter/main.h index 0d3179bef..d3c171216 100644 --- a/aegisub/reporter/main.h +++ b/aegisub/reporter/main.h @@ -16,6 +16,7 @@ /// @file main.h /// @see main.cpp +/// @ingroup base #ifndef R_PRECOMP #include diff --git a/aegisub/reporter/name_map.cpp b/aegisub/reporter/name_map.cpp index 9c8ec482b..55b5c0ed4 100644 --- a/aegisub/reporter/name_map.cpp +++ b/aegisub/reporter/name_map.cpp @@ -16,6 +16,7 @@ /// @file name_map.cpp /// @brief XML element -> human readable name mappings. +/// @ingroup base #include "report.h" diff --git a/aegisub/reporter/platform.cpp b/aegisub/reporter/platform.cpp index d6265edec..e2987d7d8 100644 --- a/aegisub/reporter/platform.cpp +++ b/aegisub/reporter/platform.cpp @@ -16,6 +16,7 @@ /// @file platform.cpp /// @brief Base functions for the Platform class. +/// @ingroup base #ifndef R_PRECOMP #include // Display* functions. diff --git a/aegisub/reporter/platform_unix.cpp b/aegisub/reporter/platform_unix.cpp index 2d67462ff..fbea41929 100644 --- a/aegisub/reporter/platform_unix.cpp +++ b/aegisub/reporter/platform_unix.cpp @@ -16,6 +16,7 @@ /// @file platform_unix.cpp /// @brief Unix Platform extension. +/// @ingroup unix #ifndef R_PRECOMP #include diff --git a/aegisub/reporter/platform_unix.h b/aegisub/reporter/platform_unix.h index 3cbcc66a1..e1ef579cd 100644 --- a/aegisub/reporter/platform_unix.h +++ b/aegisub/reporter/platform_unix.h @@ -16,6 +16,7 @@ /// @file platform_unix.h /// @see platform_unix.cpp +/// @ingroup unix class Platform; diff --git a/aegisub/reporter/platform_unix_bsd.cpp b/aegisub/reporter/platform_unix_bsd.cpp index cdb99171d..54b34ca6e 100644 --- a/aegisub/reporter/platform_unix_bsd.cpp +++ b/aegisub/reporter/platform_unix_bsd.cpp @@ -16,6 +16,7 @@ /// @file platform_unix_bsd.cpp /// @brief BSD Platform extensions. +/// @ingroup unix #ifndef R_PRECOMP #include diff --git a/aegisub/reporter/platform_unix_bsd.h b/aegisub/reporter/platform_unix_bsd.h index 1a7b9552f..e56d5752f 100644 --- a/aegisub/reporter/platform_unix_bsd.h +++ b/aegisub/reporter/platform_unix_bsd.h @@ -16,6 +16,7 @@ /// @file platform_unix_bsd.h /// @see platform_unix_bsd.cpp +/// @ingroup unix class Platform; diff --git a/aegisub/reporter/progress.cpp b/aegisub/reporter/progress.cpp index 633fe329e..0961457e3 100644 --- a/aegisub/reporter/progress.cpp +++ b/aegisub/reporter/progress.cpp @@ -16,6 +16,7 @@ /// @file progress.cpp /// @brief Progress bar when uploading data. +/// @ingroup base #include "progress.h" diff --git a/aegisub/reporter/progress.h b/aegisub/reporter/progress.h index 1ca7b3a5e..e19c4ef02 100644 --- a/aegisub/reporter/progress.h +++ b/aegisub/reporter/progress.h @@ -16,6 +16,7 @@ /// @file progress.h /// @see progress.cpp +/// @ingroup base io /// @class Progress /// @brief Progress bar. diff --git a/aegisub/reporter/r_pre.h b/aegisub/reporter/r_pre.h index 500c94680..2049aa7be 100644 --- a/aegisub/reporter/r_pre.h +++ b/aegisub/reporter/r_pre.h @@ -16,6 +16,7 @@ /// @file wx_pre.h /// @brief Precompiled header. +/// @ingroup base #define R_PRECOMP diff --git a/aegisub/reporter/report.cpp b/aegisub/reporter/report.cpp index c4b2f0fb4..0bd6e9d97 100644 --- a/aegisub/reporter/report.cpp +++ b/aegisub/reporter/report.cpp @@ -16,6 +16,7 @@ /// @file report.cpp /// @brief Generation and manipulation of reports. +/// @ingroup base #ifndef R_PRECOMP #include diff --git a/aegisub/reporter/report.h b/aegisub/reporter/report.h index d3896ff53..4f4c66b29 100644 --- a/aegisub/reporter/report.h +++ b/aegisub/reporter/report.h @@ -16,6 +16,7 @@ /// @file report.h /// @see report.cpp +/// @ingroup base #ifndef R_PRECOMP #include diff --git a/aegisub/reporter/sha256.c b/aegisub/reporter/sha256.c index 5d0ee1710..328da6e6c 100644 --- a/aegisub/reporter/sha256.c +++ b/aegisub/reporter/sha256.c @@ -29,6 +29,7 @@ /** @file sha256.c * @brief Generate SHA256 hashes. + * @ingroup base */ /** @class SHA256Context diff --git a/aegisub/reporter/sha256.h b/aegisub/reporter/sha256.h index e06b79385..6dd99d0da 100644 --- a/aegisub/reporter/sha256.h +++ b/aegisub/reporter/sha256.h @@ -27,6 +27,11 @@ * $Id$ */ +/** @file sha256.h + * @see sha256.c + * @ingroup base + */ + #ifndef _SHA256_H_ #define _SHA256_H_ diff --git a/aegisub/reporter/upload.cpp b/aegisub/reporter/upload.cpp index de0b0dd59..d239d5915 100644 --- a/aegisub/reporter/upload.cpp +++ b/aegisub/reporter/upload.cpp @@ -16,6 +16,7 @@ /// @file upload.cpp /// @brief Handle uploading of data. +/// @ingroup base io #ifndef R_PRECOMP #include diff --git a/aegisub/reporter/upload.h b/aegisub/reporter/upload.h index 944b0c84d..a4a56f5a8 100644 --- a/aegisub/reporter/upload.h +++ b/aegisub/reporter/upload.h @@ -16,6 +16,7 @@ /// @file upload.h /// @see upload.cpp +/// @ingroup base io #ifndef R_PRECMP #include diff --git a/aegisub/reporter/view.cpp b/aegisub/reporter/view.cpp index 717799980..5fef138f3 100644 --- a/aegisub/reporter/view.cpp +++ b/aegisub/reporter/view.cpp @@ -16,6 +16,7 @@ /// @file view.cpp /// @brief View report in a human readable way. +/// @ingroup base #ifndef R_PRECOMP #include diff --git a/aegisub/reporter/view.h b/aegisub/reporter/view.h index 1f424af74..3dc4ae79c 100644 --- a/aegisub/reporter/view.h +++ b/aegisub/reporter/view.h @@ -16,6 +16,7 @@ /// @file view.h /// @see view.cpp +/// @ingroup base #ifndef R_PRECOMP #include