forked from mia/Aegisub
Fix a whole bunch of Doxygen warnings.
Originally committed to SVN as r3325.
This commit is contained in:
parent
efb9ad0f0a
commit
2fd9b9d7e3
15 changed files with 37 additions and 42 deletions
|
@ -78,14 +78,14 @@ enum ASS_BlockType {
|
||||||
/// @brief AssDialogue Blocks
|
/// @brief AssDialogue Blocks
|
||||||
///
|
///
|
||||||
/// A block is each group in the text field of an AssDialogue
|
/// A block is each group in the text field of an AssDialogue
|
||||||
/// @verbatium
|
/// @verbatim
|
||||||
/// Yes, I {\i1}am{\i0} here.
|
/// Yes, I {\i1}am{\i0} here.
|
||||||
///
|
///
|
||||||
/// Gets split in five blocks:
|
/// Gets split in five blocks:
|
||||||
/// "Yes, I " (Plain)
|
/// "Yes, I " (Plain)
|
||||||
/// "\i1" (Override)
|
/// "\\i1" (Override)
|
||||||
/// "am" (Plain)
|
/// "am" (Plain)
|
||||||
/// "\i0" (Override)
|
/// "\\i0" (Override)
|
||||||
/// " here." (Plain)
|
/// " here." (Plain)
|
||||||
///
|
///
|
||||||
/// Also note how {}s are discarded.
|
/// 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 GetText() method generates a new value for the "text" field from
|
||||||
/// the other fields in the specific class, and returns the new value.
|
/// the other fields in the specific class, and returns the new value.
|
||||||
/// @endverbatium
|
/// @endverbatim
|
||||||
class AssDialogueBlock {
|
class AssDialogueBlock {
|
||||||
public:
|
public:
|
||||||
|
|
||||||
|
|
|
@ -77,7 +77,7 @@ AssFile::~AssFile() {
|
||||||
|
|
||||||
|
|
||||||
/// @brief Load generic subs
|
/// @brief Load generic subs
|
||||||
/// @param _filename
|
/// @param file
|
||||||
/// @param charset
|
/// @param charset
|
||||||
/// @param addToRecent
|
/// @param addToRecent
|
||||||
///
|
///
|
||||||
|
|
|
@ -165,9 +165,7 @@ wxString AssDialogueBlockOverride::GetText () {
|
||||||
|
|
||||||
|
|
||||||
/// @brief Process parameters via callback
|
/// @brief Process parameters via callback
|
||||||
/// @param (callback)(wxString
|
/// @param callback
|
||||||
/// @param int
|
|
||||||
/// @param )
|
|
||||||
/// @param userData
|
/// @param userData
|
||||||
///
|
///
|
||||||
void AssDialogueBlockOverride::ProcessParameters(void (*callback)(wxString,int,AssOverrideParameter *,void *),void *userData) {
|
void AssDialogueBlockOverride::ProcessParameters(void (*callback)(wxString,int,AssOverrideParameter *,void *),void *userData) {
|
||||||
|
|
|
@ -273,7 +273,7 @@ namespace Automation4 {
|
||||||
public:
|
public:
|
||||||
|
|
||||||
/// @brief DOCME
|
/// @brief DOCME
|
||||||
/// @param EVT_SHOW_CONFIG_DIALOG_t
|
/// @param event
|
||||||
/// @return
|
/// @return
|
||||||
///
|
///
|
||||||
ShowConfigDialogEvent(const wxEventType &event = EVT_SHOW_CONFIG_DIALOG_t)
|
ShowConfigDialogEvent(const wxEventType &event = EVT_SHOW_CONFIG_DIALOG_t)
|
||||||
|
|
|
@ -108,7 +108,7 @@ protected:
|
||||||
|
|
||||||
|
|
||||||
/// @brief DOCME
|
/// @brief DOCME
|
||||||
/// @param alternate=false
|
/// @param alternate
|
||||||
///
|
///
|
||||||
virtual void OnPopupMenu(bool alternate=false) {}
|
virtual void OnPopupMenu(bool alternate=false) {}
|
||||||
void ScrollTo(int y);
|
void ScrollTo(int y);
|
||||||
|
|
|
@ -306,9 +306,7 @@ size_t AegisubCSConv::iconvWrapper(iconv_t cd, char **inbuf, size_t *inbytesleft
|
||||||
|
|
||||||
/// @brief DOCME
|
/// @brief DOCME
|
||||||
/// @param code
|
/// @param code
|
||||||
/// @param buf
|
/// @param callback
|
||||||
/// @param buflen
|
|
||||||
/// @param callback_arg)
|
|
||||||
/// @param callback_arg
|
/// @param callback_arg
|
||||||
/// @param convPtr
|
/// @param convPtr
|
||||||
/// @return
|
/// @return
|
||||||
|
|
|
@ -78,7 +78,7 @@ protected:
|
||||||
/// @brief // Register one factory type (with possible subtypes)
|
/// @brief // Register one factory type (with possible subtypes)
|
||||||
/// @param factory
|
/// @param factory
|
||||||
/// @param name
|
/// @param name
|
||||||
/// @param subTypes=wxArrayString()
|
/// @param subTypes
|
||||||
///
|
///
|
||||||
static void RegisterFactory(T* factory,wxString name, wxArrayString subTypes=wxArrayString()) {
|
static void RegisterFactory(T* factory,wxString name, wxArrayString subTypes=wxArrayString()) {
|
||||||
// Create factories if it doesn't exist
|
// Create factories if it doesn't exist
|
||||||
|
@ -130,7 +130,7 @@ public:
|
||||||
|
|
||||||
|
|
||||||
/// @brief // Get list of all factories, with favourite as first
|
/// @brief // Get list of all factories, with favourite as first
|
||||||
/// @param favourite=_T(Ó)
|
/// @param favourite
|
||||||
///
|
///
|
||||||
static wxArrayString GetFactoryList(wxString favourite=_T("")) {
|
static wxArrayString GetFactoryList(wxString favourite=_T("")) {
|
||||||
if (factories == NULL) factories = new std::map<wxString,T*>;
|
if (factories == NULL) factories = new std::map<wxString,T*>;
|
||||||
|
|
|
@ -575,7 +575,6 @@ void FrameMain::OnNewWindow(wxCommandEvent& WXUNUSED(event)) {
|
||||||
|
|
||||||
|
|
||||||
/// @brief Exit
|
/// @brief Exit
|
||||||
/// @param event
|
|
||||||
///
|
///
|
||||||
void FrameMain::OnExit(wxCommandEvent& WXUNUSED(event)) {
|
void FrameMain::OnExit(wxCommandEvent& WXUNUSED(event)) {
|
||||||
Close();
|
Close();
|
||||||
|
|
|
@ -197,16 +197,16 @@ public:
|
||||||
static wxFont GetFont() { return GetInstance().font; }
|
static wxFont GetFont() { return GetInstance().font; }
|
||||||
|
|
||||||
/// @brief DOCME
|
/// @brief DOCME
|
||||||
/// @param face=_T(Ó)
|
/// @param face
|
||||||
/// @param size=10
|
/// @param size
|
||||||
/// @param bold=true
|
/// @param bold
|
||||||
/// @param italics=false
|
/// @param italics
|
||||||
///
|
///
|
||||||
static void SetFont(wxString face=_T("Verdana"),int size=10,bool bold=true,bool italics=false) { GetInstance().DoSetFont(face,size,bold,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
|
/// @brief DOCME
|
||||||
/// @param col
|
/// @param col
|
||||||
/// @param alpha=1.0f
|
/// @param alpha
|
||||||
///
|
///
|
||||||
static void SetColour(wxColour col,float alpha=1.0f) { GetInstance().DoSetColour(col,alpha); }
|
static void SetColour(wxColour col,float alpha=1.0f) { GetInstance().DoSetColour(col,alpha); }
|
||||||
|
|
||||||
|
|
|
@ -43,14 +43,14 @@
|
||||||
/// The encoding is based on an escape-character followed by a two-digit hexadecimal number, the number being the
|
/// 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).
|
/// ASCII code for the encoded character. The escape character is # (ASCII 0x23).
|
||||||
///
|
///
|
||||||
/// @verbatium
|
/// @verbatim
|
||||||
/// The following ASCII codes must be escaped:
|
/// The following ASCII codes must be escaped:
|
||||||
/// 0x00 .. 0x1F -- Control codes (nonprintable characters, including linebreaks)
|
/// 0x00 .. 0x1F -- Control codes (nonprintable characters, including linebreaks)
|
||||||
/// 0x23 -- Sharp (the escape character itself must be escaped to appear in the literal)
|
/// 0x23 -- Sharp (the escape character itself must be escaped to appear in the literal)
|
||||||
/// 0x2C -- Comma (used for field separator in standard ASS lines)
|
/// 0x2C -- Comma (used for field separator in standard ASS lines)
|
||||||
/// 0x3A -- Colon (used in some custom list formats for name:value pairs)
|
/// 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)
|
/// 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.
|
/// The encoded string should be usable in any kind of field in an ASS file.
|
||||||
|
|
||||||
|
|
|
@ -142,13 +142,13 @@ public:
|
||||||
|
|
||||||
/// @brief DOCME
|
/// @brief DOCME
|
||||||
/// @param filename
|
/// @param filename
|
||||||
/// @param forceEncoding=_T(Ó)
|
/// @param forceEncoding
|
||||||
///
|
///
|
||||||
virtual void ReadFile(wxString filename,wxString forceEncoding=_T("")) { };
|
virtual void ReadFile(wxString filename,wxString forceEncoding=_T("")) { };
|
||||||
|
|
||||||
/// @brief DOCME
|
/// @brief DOCME
|
||||||
/// @param filename
|
/// @param filename
|
||||||
/// @param encoding=_T(Ó)
|
/// @param encoding
|
||||||
///
|
///
|
||||||
virtual void WriteFile(wxString filename,wxString encoding=_T("")) { };
|
virtual void WriteFile(wxString filename,wxString encoding=_T("")) { };
|
||||||
|
|
||||||
|
|
|
@ -231,7 +231,7 @@ bool TextFileReader::HasMoreLines() {
|
||||||
|
|
||||||
|
|
||||||
/// @brief DOCME
|
/// @brief DOCME
|
||||||
/// @param enc
|
/// @param encoding
|
||||||
/// @return
|
/// @return
|
||||||
///
|
///
|
||||||
void TextFileReader::EnsureValid(wxString enc) {
|
void TextFileReader::EnsureValid(wxString enc) {
|
||||||
|
|
|
@ -285,7 +285,7 @@ public:
|
||||||
|
|
||||||
|
|
||||||
/// @brief DOCME
|
/// @brief DOCME
|
||||||
/// @param true
|
/// @param sync
|
||||||
/// @return
|
/// @return
|
||||||
///
|
///
|
||||||
void EnableAudioSync(bool sync = true) { keepAudioSync = sync; }
|
void EnableAudioSync(bool sync = true) { keepAudioSync = sync; }
|
||||||
|
|
|
@ -241,7 +241,7 @@ void VisualToolRotateXY::CommitHold() {
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/// @brief Get \org pivot
|
/// @brief Get \\org pivot
|
||||||
///
|
///
|
||||||
void VisualToolRotateXY::PopulateFeatureList() {
|
void VisualToolRotateXY::PopulateFeatureList() {
|
||||||
// Get line
|
// Get line
|
||||||
|
@ -259,7 +259,7 @@ void VisualToolRotateXY::PopulateFeatureList() {
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/// @brief Update dragging of \org
|
/// @brief Update dragging of \\org
|
||||||
/// @param feature
|
/// @param feature
|
||||||
///
|
///
|
||||||
void VisualToolRotateXY::UpdateDrag(VisualDraggableFeature &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
|
/// @param feature
|
||||||
///
|
///
|
||||||
void VisualToolRotateXY::CommitDrag(VisualDraggableFeature &feature) {
|
void VisualToolRotateXY::CommitDrag(VisualDraggableFeature &feature) {
|
||||||
|
|
|
@ -207,7 +207,7 @@ void VisualToolRotateZ::CommitHold() {
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/// @brief Get \org pivot
|
/// @brief Get \\org pivot
|
||||||
///
|
///
|
||||||
void VisualToolRotateZ::PopulateFeatureList() {
|
void VisualToolRotateZ::PopulateFeatureList() {
|
||||||
// Get line
|
// Get line
|
||||||
|
@ -225,7 +225,7 @@ void VisualToolRotateZ::PopulateFeatureList() {
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/// @brief Update dragging of \org
|
/// @brief Update dragging of \\org
|
||||||
/// @param feature
|
/// @param feature
|
||||||
///
|
///
|
||||||
void VisualToolRotateZ::UpdateDrag(VisualDraggableFeature &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
|
/// @param feature
|
||||||
///
|
///
|
||||||
void VisualToolRotateZ::CommitDrag(VisualDraggableFeature &feature) {
|
void VisualToolRotateZ::CommitDrag(VisualDraggableFeature &feature) {
|
||||||
|
|
Loading…
Reference in a new issue