From 6c0e38b868e6d5a0f704ed8c3d1c3d32b85f72b4 Mon Sep 17 00:00:00 2001
From: Amar Takhar <verm@aegisub.org>
Date: Sat, 26 Sep 2009 09:22:54 +0000
Subject: [PATCH] Fix a whole bunch of doxygen markup errors.  Also add missing
 docs.

Originally committed to SVN as r3555.
---
 aegisub/reporter/aegisub.cpp           |  2 +-
 aegisub/reporter/aegisub.h             |  4 +++-
 aegisub/reporter/include/platform.h    |  2 +-
 aegisub/reporter/main.cpp              |  2 +-
 aegisub/reporter/main.h                |  2 +-
 aegisub/reporter/name_map.cpp          |  2 +-
 aegisub/reporter/platform.cpp          |  2 +-
 aegisub/reporter/platform_unix.cpp     |  2 +-
 aegisub/reporter/platform_unix.h       |  4 ++--
 aegisub/reporter/platform_unix_bsd.cpp |  2 +-
 aegisub/reporter/platform_unix_bsd.h   |  4 ++--
 aegisub/reporter/progress.cpp          |  2 +-
 aegisub/reporter/progress.h            |  2 +-
 aegisub/reporter/r_pre.h               |  2 +-
 aegisub/reporter/report.cpp            |  2 +-
 aegisub/reporter/report.h              | 11 +++++++++--
 aegisub/reporter/sha256.c              |  8 ++++++++
 aegisub/reporter/upload.cpp            |  2 +-
 aegisub/reporter/upload.h              |  2 +-
 aegisub/reporter/view.cpp              |  2 +-
 aegisub/reporter/view.h                |  4 +++-
 21 files changed, 42 insertions(+), 23 deletions(-)

diff --git a/aegisub/reporter/aegisub.cpp b/aegisub/reporter/aegisub.cpp
index 569b5f1b8..033db3d7e 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 47910aa5f..f1eb2c073 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 1dcf65635..88d0474a7 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 d043cf564..9d05db6e5 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 31ddacfa4..0d3179bef 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 50333e9a5..9c8ec482b 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 f8d9579e8..d6265edec 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 9061750e5..2d67462ff 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 6954f0d66..3cbcc66a1 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 9d9d50d2c..cdb99171d 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 37896128a..1a7b9552f 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 a5870d029..633fe329e 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 ddb7e4d1e..1ca7b3a5e 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 a527a54e5..500c94680 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 d961408ba..c4b2f0fb4 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 3ebabdfbd..d3896ff53 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 0649660f0..5d0ee1710 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 483aa0e00..de0b0dd59 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 55eb82e41..944b0c84d 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 58c18bee0..717799980 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 14366dd32..1f424af74 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);
-- 
GitLab