Fix a whole bunch of doxygen markup errors. Also add missing docs.
Originally committed to SVN as r3555.
This commit is contained in:
Amar Takhar
parent
3d08e60f5b
commit
6c0e38b868
21 changed files with 42 additions and 23 deletions
|
|
@ -14,7 +14,7 @@
|
|||
//
|
||||
// $Id$
|
||||
|
||||
/// @@file aegisub.cpp
|
||||
/// @file aegisub.cpp
|
||||
/// @brief Aegisub specific configuration options and properties.
|
||||
|
||||
#ifndef R_PRECOMP
|
||||
|
|
|
|||
|
|
@ -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;
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
//
|
||||
// $Id$
|
||||
|
||||
/// @@file platform.h
|
||||
/// @file platform.h
|
||||
/// @brief API for gathering platform information.
|
||||
/// @see platform.cpp
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
//
|
||||
// $Id$
|
||||
|
||||
/// @@file main.cpp
|
||||
/// @file main.cpp
|
||||
/// @brief Main loop
|
||||
|
||||
#ifndef R_PRECOMP
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
//
|
||||
// $Id$
|
||||
|
||||
/// @@file main.h
|
||||
/// @file main.h
|
||||
/// @see main.cpp
|
||||
|
||||
#ifndef R_PRECOMP
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
//
|
||||
// $Id$
|
||||
|
||||
/// @@file name_map.cpp
|
||||
/// @file name_map.cpp
|
||||
/// @brief XML element -> human readable name mappings.
|
||||
|
||||
#include "report.h"
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
//
|
||||
// $Id$
|
||||
|
||||
/// @@file platform.cpp
|
||||
/// @file platform.cpp
|
||||
/// @brief Base functions for the Platform class.
|
||||
|
||||
#ifndef R_PRECOMP
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
//
|
||||
// $Id$
|
||||
|
||||
/// @@file platform_unix.cpp
|
||||
/// @file platform_unix.cpp
|
||||
/// @brief Unix Platform extension.
|
||||
|
||||
#ifndef R_PRECOMP
|
||||
|
|
|
|||
|
|
@ -14,8 +14,8 @@
|
|||
//
|
||||
// $Id$
|
||||
|
||||
/// @@file platform_unix.h
|
||||
/// @brief @see platform_unix.cpp
|
||||
/// @file platform_unix.h
|
||||
/// @see platform_unix.cpp
|
||||
|
||||
class Platform;
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
//
|
||||
// $Id$
|
||||
|
||||
/// @@file platform_unix_bsd.cpp
|
||||
/// @file platform_unix_bsd.cpp
|
||||
/// @brief BSD Platform extensions.
|
||||
|
||||
#ifndef R_PRECOMP
|
||||
|
|
|
|||
|
|
@ -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;
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
//
|
||||
// $Id$
|
||||
|
||||
/// @@file progress.cpp
|
||||
/// @file progress.cpp
|
||||
/// @brief Progress bar when uploading data.
|
||||
|
||||
#include "progress.h"
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
//
|
||||
// $Id$
|
||||
|
||||
/// @@file progress.h
|
||||
/// @file progress.h
|
||||
/// @see progress.cpp
|
||||
|
||||
/// @class Progress
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
//
|
||||
// $Id$
|
||||
|
||||
/// @@file wx_pre.h
|
||||
/// @file wx_pre.h
|
||||
/// @brief Precompiled header.
|
||||
|
||||
#define R_PRECOMP
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
//
|
||||
// $Id$
|
||||
|
||||
/// @@file report.cpp
|
||||
/// @file report.cpp
|
||||
/// @brief Generation and manipulation of reports.
|
||||
|
||||
#ifndef R_PRECOMP
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -27,6 +27,14 @@
|
|||
* $Id$
|
||||
*/
|
||||
|
||||
/** @file sha256.c
|
||||
* @brief Generate SHA256 hashes.
|
||||
*/
|
||||
|
||||
/** @class SHA256Context
|
||||
* @brief Generate SHA256 hashes.
|
||||
*/
|
||||
|
||||
#include <string.h>
|
||||
|
||||
#include "sha256.h"
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
//
|
||||
// $Id$
|
||||
|
||||
/// @@file upload.cpp
|
||||
/// @file upload.cpp
|
||||
/// @brief Handle uploading of data.
|
||||
|
||||
#ifndef R_PRECOMP
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
//
|
||||
// $Id$
|
||||
|
||||
/// @@file upload.h
|
||||
/// @file upload.h
|
||||
/// @see upload.cpp
|
||||
|
||||
#ifndef R_PRECMP
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
//
|
||||
// $Id$
|
||||
|
||||
/// @@file view.cpp
|
||||
/// @file view.cpp
|
||||
/// @brief View report in a human readable way.
|
||||
|
||||
#ifndef R_PRECOMP
|
||||
|
|
|
|||
|
|
@ -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);
|
||||
|
|
|
|||
Loading…
Reference in a new issue