Fix a whole bunch of Doxygen warnings.

Originally committed to SVN as r3325.
This commit is contained in:
Amar Takhar 2009-07-30 03:36:53 +00:00
parent efb9ad0f0a
commit 2fd9b9d7e3
15 changed files with 37 additions and 42 deletions

View File

@ -78,14 +78,14 @@ enum ASS_BlockType {
/// @brief AssDialogue Blocks
///
/// A block is each group in the text field of an AssDialogue
/// @verbatium
/// @verbatim
/// Yes, I {\i1}am{\i0} here.
///
/// Gets split in five blocks:
/// "Yes, I " (Plain)
/// "\i1" (Override)
/// "\\i1" (Override)
/// "am" (Plain)
/// "\i0" (Override)
/// "\\i0" (Override)
/// " here." (Plain)
///
/// Also note how {}s are discarded.
@ -93,7 +93,7 @@ enum ASS_BlockType {
///
/// The GetText() method generates a new value for the "text" field from
/// the other fields in the specific class, and returns the new value.
/// @endverbatium
/// @endverbatim
class AssDialogueBlock {
public:

View File

@ -77,7 +77,7 @@ AssFile::~AssFile() {
/// @brief Load generic subs
/// @param _filename
/// @param file
/// @param charset
/// @param addToRecent
///

View File

@ -165,10 +165,8 @@ wxString AssDialogueBlockOverride::GetText () {
/// @brief Process parameters via callback
/// @param (callback)(wxString
/// @param int
/// @param )
/// @param userData
/// @param callback
/// @param userData
///
void AssDialogueBlockOverride::ProcessParameters(void (*callback)(wxString,int,AssOverrideParameter *,void *),void *userData) {
AssOverrideTag *curTag;

View File

@ -273,7 +273,7 @@ namespace Automation4 {
public:
/// @brief DOCME
/// @param EVT_SHOW_CONFIG_DIALOG_t
/// @param event
/// @return
///
ShowConfigDialogEvent(const wxEventType &event = EVT_SHOW_CONFIG_DIALOG_t)

View File

@ -108,7 +108,7 @@ protected:
/// @brief DOCME
/// @param alternate=false
/// @param alternate
///
virtual void OnPopupMenu(bool alternate=false) {}
void ScrollTo(int y);

View File

@ -305,12 +305,10 @@ size_t AegisubCSConv::iconvWrapper(iconv_t cd, char **inbuf, size_t *inbytesleft
/// @brief DOCME
/// @param code
/// @param buf
/// @param buflen
/// @param callback_arg)
/// @param callback_arg
/// @param convPtr
/// @param code
/// @param callback
/// @param callback_arg
/// @param convPtr
/// @return
///
void AegisubCSConv::ucToMbFallback(

View File

@ -76,9 +76,9 @@ protected:
/// @brief // Register one factory type (with possible subtypes)
/// @param factory
/// @param name
/// @param subTypes=wxArrayString()
/// @param factory
/// @param name
/// @param subTypes
///
static void RegisterFactory(T* factory,wxString name, wxArrayString subTypes=wxArrayString()) {
// Create factories if it doesn't exist
@ -130,7 +130,7 @@ public:
/// @brief // Get list of all factories, with favourite as first
/// @param favourite=_T(Ó)
/// @param favourite
///
static wxArrayString GetFactoryList(wxString favourite=_T("")) {
if (factories == NULL) factories = new std::map<wxString,T*>;

View File

@ -575,7 +575,6 @@ void FrameMain::OnNewWindow(wxCommandEvent& WXUNUSED(event)) {
/// @brief Exit
/// @param event
///
void FrameMain::OnExit(wxCommandEvent& WXUNUSED(event)) {
Close();

View File

@ -197,16 +197,16 @@ public:
static wxFont GetFont() { return GetInstance().font; }
/// @brief DOCME
/// @param face=_T(Ó)
/// @param size=10
/// @param bold=true
/// @param italics=false
/// @param face
/// @param size
/// @param bold
/// @param italics
///
static void SetFont(wxString face=_T("Verdana"),int size=10,bool bold=true,bool italics=false) { GetInstance().DoSetFont(face,size,bold,italics); }
/// @brief DOCME
/// @param col
/// @param alpha=1.0f
/// @param col
/// @param alpha
///
static void SetColour(wxColour col,float alpha=1.0f) { GetInstance().DoSetColour(col,alpha); }

View File

@ -43,14 +43,14 @@
/// The encoding is based on an escape-character followed by a two-digit hexadecimal number, the number being the
/// ASCII code for the encoded character. The escape character is # (ASCII 0x23).
///
/// @verbatium
/// @verbatim
/// The following ASCII codes must be escaped:
/// 0x00 .. 0x1F -- Control codes (nonprintable characters, including linebreaks)
/// 0x23 -- Sharp (the escape character itself must be escaped to appear in the literal)
/// 0x2C -- Comma (used for field separator in standard ASS lines)
/// 0x3A -- Colon (used in some custom list formats for name:value pairs)
/// 0x7C -- Pipe (used in some custom lists, as item separator, eg. itemA|itemB)
/// @endverbatium
/// @endverbatim
///
/// The encoded string should be usable in any kind of field in an ASS file.

View File

@ -141,14 +141,14 @@ public:
virtual bool CanWriteFile(wxString filename) { return false; };
/// @brief DOCME
/// @param filename
/// @param forceEncoding=_T(Ó)
/// @param filename
/// @param forceEncoding
///
virtual void ReadFile(wxString filename,wxString forceEncoding=_T("")) { };
/// @brief DOCME
/// @param filename
/// @param encoding=_T(Ó)
/// @param filename
/// @param encoding
///
virtual void WriteFile(wxString filename,wxString encoding=_T("")) { };

View File

@ -231,7 +231,7 @@ bool TextFileReader::HasMoreLines() {
/// @brief DOCME
/// @param enc
/// @param encoding
/// @return
///
void TextFileReader::EnsureValid(wxString enc) {

View File

@ -285,7 +285,7 @@ public:
/// @brief DOCME
/// @param true
/// @param sync
/// @return
///
void EnableAudioSync(bool sync = true) { keepAudioSync = sync; }

View File

@ -241,7 +241,7 @@ void VisualToolRotateXY::CommitHold() {
/// @brief Get \org pivot
/// @brief Get \\org pivot
///
void VisualToolRotateXY::PopulateFeatureList() {
// Get line
@ -259,7 +259,7 @@ void VisualToolRotateXY::PopulateFeatureList() {
/// @brief Update dragging of \org
/// @brief Update dragging of \\org
/// @param feature
///
void VisualToolRotateXY::UpdateDrag(VisualDraggableFeature &feature) {
@ -269,7 +269,7 @@ void VisualToolRotateXY::UpdateDrag(VisualDraggableFeature &feature) {
/// @brief Commit dragging of \org
/// @brief Commit dragging of \\org
/// @param feature
///
void VisualToolRotateXY::CommitDrag(VisualDraggableFeature &feature) {

View File

@ -207,7 +207,7 @@ void VisualToolRotateZ::CommitHold() {
/// @brief Get \org pivot
/// @brief Get \\org pivot
///
void VisualToolRotateZ::PopulateFeatureList() {
// Get line
@ -225,7 +225,7 @@ void VisualToolRotateZ::PopulateFeatureList() {
/// @brief Update dragging of \org
/// @brief Update dragging of \\org
/// @param feature
///
void VisualToolRotateZ::UpdateDrag(VisualDraggableFeature &feature) {
@ -235,7 +235,7 @@ void VisualToolRotateZ::UpdateDrag(VisualDraggableFeature &feature) {
/// @brief Commit dragging of \org
/// @brief Commit dragging of \\org
/// @param feature
///
void VisualToolRotateZ::CommitDrag(VisualDraggableFeature &feature) {