diff --git a/aegisub/reporter/aegisub.cpp b/aegisub/reporter/aegisub.cpp index 569b5f1b8660b77f467471d93bad4fdf6348cccf..033db3d7e3129f17eb5a210cd610336467697f03 100644 --- a/aegisub/reporter/aegisub.cpp +++ b/aegisub/reporter/aegisub.cpp @@ -14,7 +14,7 @@ // // $Id$ -/// @@file aegisub.cpp +/// @file aegisub.cpp /// @brief Aegisub specific configuration options and properties. #ifndef R_PRECOMP diff --git a/aegisub/reporter/aegisub.h b/aegisub/reporter/aegisub.h index 47910aa5f67fa25c611b4c7017fdfed61ab813d8..f1eb2c0730879a68a2806b793f21f68427b5b79e 100644 --- a/aegisub/reporter/aegisub.h +++ b/aegisub/reporter/aegisub.h @@ -14,9 +14,11 @@ // // $Id$ -/// @@file aegisub.h +/// @file aegisub.h /// @see aegisub.cpp +/// @class Aegisub +/// @brief Gather Aegisub information from the config file or otherwise. class Aegisub { private: wxFileConfig *conf; diff --git a/aegisub/reporter/include/platform.h b/aegisub/reporter/include/platform.h index 1dcf65635d624ab308786586d62abcc85725e269..88d0474a7253f2e4cafb8b991bf00c48110f87cc 100644 --- a/aegisub/reporter/include/platform.h +++ b/aegisub/reporter/include/platform.h @@ -14,7 +14,7 @@ // // $Id$ -/// @@file platform.h +/// @file platform.h /// @brief API for gathering platform information. /// @see platform.cpp diff --git a/aegisub/reporter/main.cpp b/aegisub/reporter/main.cpp index d043cf5646cb60c08f3b07f999c0cdbeafca4e27..9d05db6e5e885bcb1ae4d16cd06449b1403879e2 100644 --- a/aegisub/reporter/main.cpp +++ b/aegisub/reporter/main.cpp @@ -14,7 +14,7 @@ // // $Id$ -/// @@file main.cpp +/// @file main.cpp /// @brief Main loop #ifndef R_PRECOMP diff --git a/aegisub/reporter/main.h b/aegisub/reporter/main.h index 31ddacfa46feb7a2f1569053ddb63669b1673f00..0d3179bef1da81a2e77e85f07ba1a4ffb55f22a9 100644 --- a/aegisub/reporter/main.h +++ b/aegisub/reporter/main.h @@ -14,7 +14,7 @@ // // $Id$ -/// @@file main.h +/// @file main.h /// @see main.cpp #ifndef R_PRECOMP diff --git a/aegisub/reporter/name_map.cpp b/aegisub/reporter/name_map.cpp index 50333e9a5b042c9e47f83c1f6358262842750b23..9c8ec482bebdb669587f9607b8cec5b73a7eaa7a 100644 --- a/aegisub/reporter/name_map.cpp +++ b/aegisub/reporter/name_map.cpp @@ -14,7 +14,7 @@ // // $Id$ -/// @@file name_map.cpp +/// @file name_map.cpp /// @brief XML element -> human readable name mappings. #include "report.h" diff --git a/aegisub/reporter/platform.cpp b/aegisub/reporter/platform.cpp index f8d9579e87582188d03d8821ee12d2a4870b7feb..d6265edec8c4f49237019da66d4215d8fd2be222 100644 --- a/aegisub/reporter/platform.cpp +++ b/aegisub/reporter/platform.cpp @@ -14,7 +14,7 @@ // // $Id$ -/// @@file platform.cpp +/// @file platform.cpp /// @brief Base functions for the Platform class. #ifndef R_PRECOMP diff --git a/aegisub/reporter/platform_unix.cpp b/aegisub/reporter/platform_unix.cpp index 9061750e564e8c79b2f414896f1e969ce2dd6682..2d67462ff3b381e13e6c2b2dc500e6b7a327d473 100644 --- a/aegisub/reporter/platform_unix.cpp +++ b/aegisub/reporter/platform_unix.cpp @@ -14,7 +14,7 @@ // // $Id$ -/// @@file platform_unix.cpp +/// @file platform_unix.cpp /// @brief Unix Platform extension. #ifndef R_PRECOMP diff --git a/aegisub/reporter/platform_unix.h b/aegisub/reporter/platform_unix.h index 6954f0d660850ae9e2c75cb851cf4777fc318f89..3cbcc66a17d4a2948849d8b6ad0592044287c4b4 100644 --- a/aegisub/reporter/platform_unix.h +++ b/aegisub/reporter/platform_unix.h @@ -14,8 +14,8 @@ // // $Id$ -/// @@file platform_unix.h -/// @brief @see platform_unix.cpp +/// @file platform_unix.h +/// @see platform_unix.cpp class Platform; diff --git a/aegisub/reporter/platform_unix_bsd.cpp b/aegisub/reporter/platform_unix_bsd.cpp index 9d9d50d2c61d6fb2d7aa57ecd5d37cba23e8f0c9..cdb99171d27966c9d27cd179fdaaa77e7008ca1e 100644 --- a/aegisub/reporter/platform_unix_bsd.cpp +++ b/aegisub/reporter/platform_unix_bsd.cpp @@ -14,7 +14,7 @@ // // $Id$ -/// @@file platform_unix_bsd.cpp +/// @file platform_unix_bsd.cpp /// @brief BSD Platform extensions. #ifndef R_PRECOMP diff --git a/aegisub/reporter/platform_unix_bsd.h b/aegisub/reporter/platform_unix_bsd.h index 37896128ac7caf69d2590a929faa1f6947fbd8bf..1a7b9552f04fb6f3038ec0345ab39636624af684 100644 --- a/aegisub/reporter/platform_unix_bsd.h +++ b/aegisub/reporter/platform_unix_bsd.h @@ -14,8 +14,8 @@ // // $Id$ -/// @@file platform_unix_bsd.h -/// @brief @see platform_unix_bsd.cpp +/// @file platform_unix_bsd.h +/// @see platform_unix_bsd.cpp class Platform; diff --git a/aegisub/reporter/progress.cpp b/aegisub/reporter/progress.cpp index a5870d029fa47d070dc2b194f5c98be8ea0c8a21..633fe329e8b90dcf9b3a4e9ae62590145e9eee5a 100644 --- a/aegisub/reporter/progress.cpp +++ b/aegisub/reporter/progress.cpp @@ -14,7 +14,7 @@ // // $Id$ -/// @@file progress.cpp +/// @file progress.cpp /// @brief Progress bar when uploading data. #include "progress.h" diff --git a/aegisub/reporter/progress.h b/aegisub/reporter/progress.h index ddb7e4d1e494b088f9c14335770a96f52b7c3e69..1ca7b3a5e4927f20f8dff2cfbea10adb3799c3e4 100644 --- a/aegisub/reporter/progress.h +++ b/aegisub/reporter/progress.h @@ -14,7 +14,7 @@ // // $Id$ -/// @@file progress.h +/// @file progress.h /// @see progress.cpp /// @class Progress diff --git a/aegisub/reporter/r_pre.h b/aegisub/reporter/r_pre.h index a527a54e53fa7b85283e5805287be56f50715244..500c94680940b68403b30c7112940e3ea435f4d8 100644 --- a/aegisub/reporter/r_pre.h +++ b/aegisub/reporter/r_pre.h @@ -14,7 +14,7 @@ // // $Id$ -/// @@file wx_pre.h +/// @file wx_pre.h /// @brief Precompiled header. #define R_PRECOMP diff --git a/aegisub/reporter/report.cpp b/aegisub/reporter/report.cpp index d961408ba1d11d3000529bab140c5cb04fe6441f..c4b2f0fb4760c51647a865a0df2f01c4a42d51f5 100644 --- a/aegisub/reporter/report.cpp +++ b/aegisub/reporter/report.cpp @@ -14,7 +14,7 @@ // // $Id$ -/// @@file report.cpp +/// @file report.cpp /// @brief Generation and manipulation of reports. #ifndef R_PRECOMP diff --git a/aegisub/reporter/report.h b/aegisub/reporter/report.h index 3ebabdfbd22687eb847f4617def7349b012a6b40..d3896ff53396f2d25ecdec3382d4ecf676992958 100644 --- a/aegisub/reporter/report.h +++ b/aegisub/reporter/report.h @@ -14,7 +14,7 @@ // // $Id$ -/// @@file report.h +/// @file report.h /// @see report.cpp #ifndef R_PRECOMP @@ -24,7 +24,8 @@ #include <wx/listctrl.h> #endif - +/// @class Report +/// @brief Report generator. class Report { public: @@ -35,12 +36,18 @@ public: wxString AsText(); private: + /// Comparison callback for nameMap. struct lst_comp { bool operator() (const wxString &a, const wxString &b) { return a.Cmp(b) < 0; } }; + + /// Map of internal XML elements to human readable names. typedef std::map<std::string, std::string, lst_comp> nameMap; + + /// element->human name pairs. typedef std::pair<std::string, std::string> nPair; + /// Struct to hold generatex XML Report. struct XMLReport { wxXmlDocument *doc; /// Parent document. wxXmlNode *report; /// Root node. diff --git a/aegisub/reporter/sha256.c b/aegisub/reporter/sha256.c index 0649660f01b025254f8c844af5fa250ed7f8894b..5d0ee171050a4865566509562f9762fd198215d6 100644 --- a/aegisub/reporter/sha256.c +++ b/aegisub/reporter/sha256.c @@ -27,6 +27,14 @@ * $Id$ */ +/** @file sha256.c + * @brief Generate SHA256 hashes. + */ + +/** @class SHA256Context + * @brief Generate SHA256 hashes. + */ + #include <string.h> #include "sha256.h" diff --git a/aegisub/reporter/upload.cpp b/aegisub/reporter/upload.cpp index 483aa0e0029b60a78a26a03c89d6fb9a205c6767..de0b0dd597fc5ab216f990fe92eab2f1f29751a2 100644 --- a/aegisub/reporter/upload.cpp +++ b/aegisub/reporter/upload.cpp @@ -14,7 +14,7 @@ // // $Id$ -/// @@file upload.cpp +/// @file upload.cpp /// @brief Handle uploading of data. #ifndef R_PRECOMP diff --git a/aegisub/reporter/upload.h b/aegisub/reporter/upload.h index 55eb82e41e5fa79de1c7089e08f81a89c81f64bf..944b0c84df7159082cd38f5f24203823d34818fd 100644 --- a/aegisub/reporter/upload.h +++ b/aegisub/reporter/upload.h @@ -14,7 +14,7 @@ // // $Id$ -/// @@file upload.h +/// @file upload.h /// @see upload.cpp #ifndef R_PRECMP diff --git a/aegisub/reporter/view.cpp b/aegisub/reporter/view.cpp index 58c18bee028d82b38b17dde7c8532f5888303cf4..71779998068ae79efbffebda7d88cf8abcc0fcb9 100644 --- a/aegisub/reporter/view.cpp +++ b/aegisub/reporter/view.cpp @@ -14,7 +14,7 @@ // // $Id$ -/// @@file view.cpp +/// @file view.cpp /// @brief View report in a human readable way. #ifndef R_PRECOMP diff --git a/aegisub/reporter/view.h b/aegisub/reporter/view.h index 14366dd32f6ea8388e28a462aa3a75d20189be61..1f424af7453f91e8ddbd6a0ddca519dbecfcf6ce 100644 --- a/aegisub/reporter/view.h +++ b/aegisub/reporter/view.h @@ -14,7 +14,7 @@ // // $Id$ -/// @@file view.h +/// @file view.h /// @see view.cpp #ifndef R_PRECOMP @@ -26,6 +26,8 @@ #include "report.h" +/// @class View +/// @brief View the stored report. class View: public wxDialog { public: View(wxWindow *frame, Report *r);