Add @ingroup tags and another doxygen comment.

Originally committed to SVN as r3558.
This commit is contained in:
Amar Takhar 2009-09-26 09:38:17 +00:00
parent 16a6616da7
commit c98fe933a4
22 changed files with 26 additions and 0 deletions

View file

@ -16,6 +16,7 @@
/// @file aegisub.cpp /// @file aegisub.cpp
/// @brief Aegisub specific configuration options and properties. /// @brief Aegisub specific configuration options and properties.
/// @ingroup base
#ifndef R_PRECOMP #ifndef R_PRECOMP
#include <wx/fileconf.h> #include <wx/fileconf.h>

View file

@ -16,6 +16,7 @@
/// @file aegisub.h /// @file aegisub.h
/// @see aegisub.cpp /// @see aegisub.cpp
/// @ingroup base
/// @class Aegisub /// @class Aegisub
/// @brief Gather Aegisub information from the config file or otherwise. /// @brief Gather Aegisub information from the config file or otherwise.

View file

@ -17,6 +17,7 @@
/// @file platform.h /// @file platform.h
/// @brief API for gathering platform information. /// @brief API for gathering platform information.
/// @see platform.cpp /// @see platform.cpp
/// @ingroup base
#ifndef R_PRECOMP #ifndef R_PRECOMP
#include <wx/platinfo.h> #include <wx/platinfo.h>

View file

@ -16,6 +16,7 @@
/// @file main.cpp /// @file main.cpp
/// @brief Main loop /// @brief Main loop
/// @ingroup base
#ifndef R_PRECOMP #ifndef R_PRECOMP
#include <locale.h> #include <locale.h>

View file

@ -16,6 +16,7 @@
/// @file main.h /// @file main.h
/// @see main.cpp /// @see main.cpp
/// @ingroup base
#ifndef R_PRECOMP #ifndef R_PRECOMP
#include <wx/frame.h> #include <wx/frame.h>

View file

@ -16,6 +16,7 @@
/// @file name_map.cpp /// @file name_map.cpp
/// @brief XML element -> human readable name mappings. /// @brief XML element -> human readable name mappings.
/// @ingroup base
#include "report.h" #include "report.h"

View file

@ -16,6 +16,7 @@
/// @file platform.cpp /// @file platform.cpp
/// @brief Base functions for the Platform class. /// @brief Base functions for the Platform class.
/// @ingroup base
#ifndef R_PRECOMP #ifndef R_PRECOMP
#include <wx/gdicmn.h> // Display* functions. #include <wx/gdicmn.h> // Display* functions.

View file

@ -16,6 +16,7 @@
/// @file platform_unix.cpp /// @file platform_unix.cpp
/// @brief Unix Platform extension. /// @brief Unix Platform extension.
/// @ingroup unix
#ifndef R_PRECOMP #ifndef R_PRECOMP
#include <wx/string.h> #include <wx/string.h>

View file

@ -16,6 +16,7 @@
/// @file platform_unix.h /// @file platform_unix.h
/// @see platform_unix.cpp /// @see platform_unix.cpp
/// @ingroup unix
class Platform; class Platform;

View file

@ -16,6 +16,7 @@
/// @file platform_unix_bsd.cpp /// @file platform_unix_bsd.cpp
/// @brief BSD Platform extensions. /// @brief BSD Platform extensions.
/// @ingroup unix
#ifndef R_PRECOMP #ifndef R_PRECOMP
#include <wx/string.h> #include <wx/string.h>

View file

@ -16,6 +16,7 @@
/// @file platform_unix_bsd.h /// @file platform_unix_bsd.h
/// @see platform_unix_bsd.cpp /// @see platform_unix_bsd.cpp
/// @ingroup unix
class Platform; class Platform;

View file

@ -16,6 +16,7 @@
/// @file progress.cpp /// @file progress.cpp
/// @brief Progress bar when uploading data. /// @brief Progress bar when uploading data.
/// @ingroup base
#include "progress.h" #include "progress.h"

View file

@ -16,6 +16,7 @@
/// @file progress.h /// @file progress.h
/// @see progress.cpp /// @see progress.cpp
/// @ingroup base io
/// @class Progress /// @class Progress
/// @brief Progress bar. /// @brief Progress bar.

View file

@ -16,6 +16,7 @@
/// @file wx_pre.h /// @file wx_pre.h
/// @brief Precompiled header. /// @brief Precompiled header.
/// @ingroup base
#define R_PRECOMP #define R_PRECOMP

View file

@ -16,6 +16,7 @@
/// @file report.cpp /// @file report.cpp
/// @brief Generation and manipulation of reports. /// @brief Generation and manipulation of reports.
/// @ingroup base
#ifndef R_PRECOMP #ifndef R_PRECOMP
#include <wx/intl.h> #include <wx/intl.h>

View file

@ -16,6 +16,7 @@
/// @file report.h /// @file report.h
/// @see report.cpp /// @see report.cpp
/// @ingroup base
#ifndef R_PRECOMP #ifndef R_PRECOMP
#include <map> #include <map>

View file

@ -29,6 +29,7 @@
/** @file sha256.c /** @file sha256.c
* @brief Generate SHA256 hashes. * @brief Generate SHA256 hashes.
* @ingroup base
*/ */
/** @class SHA256Context /** @class SHA256Context

View file

@ -27,6 +27,11 @@
* $Id$ * $Id$
*/ */
/** @file sha256.h
* @see sha256.c
* @ingroup base
*/
#ifndef _SHA256_H_ #ifndef _SHA256_H_
#define _SHA256_H_ #define _SHA256_H_

View file

@ -16,6 +16,7 @@
/// @file upload.cpp /// @file upload.cpp
/// @brief Handle uploading of data. /// @brief Handle uploading of data.
/// @ingroup base io
#ifndef R_PRECOMP #ifndef R_PRECOMP
#include <wx/file.h> #include <wx/file.h>

View file

@ -16,6 +16,7 @@
/// @file upload.h /// @file upload.h
/// @see upload.cpp /// @see upload.cpp
/// @ingroup base io
#ifndef R_PRECMP #ifndef R_PRECMP
#include <curl/curl.h> #include <curl/curl.h>

View file

@ -16,6 +16,7 @@
/// @file view.cpp /// @file view.cpp
/// @brief View report in a human readable way. /// @brief View report in a human readable way.
/// @ingroup base
#ifndef R_PRECOMP #ifndef R_PRECOMP
#include <wx/window.h> #include <wx/window.h>

View file

@ -16,6 +16,7 @@
/// @file view.h /// @file view.h
/// @see view.cpp /// @see view.cpp
/// @ingroup base
#ifndef R_PRECOMP #ifndef R_PRECOMP
#include <wx/frame.h> #include <wx/frame.h>