diff --git a/aegisub/src/aegisub_endian.h b/aegisub/src/aegisub_endian.h index a1f91c87a..d738fd1ba 100644 --- a/aegisub/src/aegisub_endian.h +++ b/aegisub/src/aegisub_endian.h @@ -33,7 +33,6 @@ // Sanity check - #ifndef HAVE_LITTLE_ENDIAN # ifndef HAVE_BIG_ENDIAN // We neither have big nor little endian from configuration @@ -41,23 +40,15 @@ // But this is an OS X system building a universal binary // Apple's GCC defines _BIG_ENDIAN when building for PPC # ifdef _BIG_ENDIAN - -/// DOCME # define HAVE_BIG_ENDIAN # else - -/// DOCME # define HAVE_LITTLE_ENDIAN # endif - -/// DOCME # undef HAVE_DYNAMIC_ENDIAN # else // !HAVE_UNIVERSAL_ENDIAN // We aren't building an OS X universal binary // Use the dynamic endian code # ifndef HAVE_DYNAMIC_ENDIAN - -/// DOCME # define HAVE_DYNAMIC_ENDIAN # endif # endif //HAVE_UNIVERSAL_ENDIAN @@ -72,20 +63,11 @@ #include - -/// DOCME namespace Endian { - // Unconditionally reverse endianness // These are only defined for unsigned ints, // Use reinterpret_cast on the values if you need signed values. - - - /// @brief DOCME - /// @param val - /// @return - /// inline uint16_t Reverse(uint16_t val) { return @@ -93,11 +75,6 @@ namespace Endian { ((val & 0xFF00) >> 8); } - - /// @brief DOCME - /// @param val - /// @return - /// inline uint32_t Reverse(uint32_t val) { return @@ -107,11 +84,6 @@ namespace Endian { ((val & 0xFF000000) >> 24); } - - /// @brief DOCME - /// @param val - /// @return - /// inline uint64_t Reverse(uint64_t val) { return @@ -129,11 +101,7 @@ namespace Endian { #ifndef HAVE_DYNAMIC_ENDIAN // Regular, fast, templatized conditional reversing - /// @brief DOCME - /// @param val - /// @return - /// - template + template inline T LittleToMachine(T val) { #ifdef HAVE_BIG_ENDIAN @@ -145,11 +113,7 @@ namespace Endian { #endif } - /// @brief DOCME - /// @param val - /// @return - /// - template + template inline T BigToMachine(T val) { #ifdef HAVE_LITTLE_ENDIAN @@ -161,11 +125,7 @@ namespace Endian { #endif } - /// @brief DOCME - /// @param val - /// @return - /// - template + template inline T MachineToLittle(T val) { #ifdef HAVE_BIG_ENDIAN @@ -177,11 +137,7 @@ namespace Endian { #endif } - /// @brief DOCME - /// @param val - /// @return - /// - template + template inline T MachineToBig(T val) { #ifdef HAVE_LITTLE_ENDIAN @@ -206,41 +162,23 @@ namespace Endian { // Unions to pack together ints and get their physical bytes - - /// DOCME union bytes16 { - /// DOCME uint8_t byte[2]; - - /// DOCME uint16_t word; }; - /// DOCME union bytes32 { - /// DOCME uint8_t byte[4]; - - /// DOCME uint32_t word; }; - /// DOCME union bytes64 { - /// DOCME uint8_t byte[8]; - - /// DOCME uint64_t word; }; // 16 bit words - - /// @brief DOCME - /// @param val - /// @return - /// inline uint16_t MachineToBig(uint16_t val) { bytes16 pack; @@ -251,11 +189,6 @@ namespace Endian { return pack.word; } - - /// @brief DOCME - /// @param val - /// @return - /// inline uint16_t MachineToLittle(uint16_t val) { bytes16 pack; @@ -266,11 +199,6 @@ namespace Endian { return pack.word; } - - /// @brief DOCME - /// @param val - /// @return - /// inline uint16_t BigToMachine(uint16_t val) { bytes16 pack; @@ -280,11 +208,6 @@ namespace Endian { return uint16_t(pack.byte[1]) | (uint16_t(pack.byte[0]) << 8); } - - /// @brief DOCME - /// @param val - /// @return - /// inline uint16_t LittleToMachine(uint16_t val) { bytes16 pack; @@ -297,11 +220,6 @@ namespace Endian { // 32 bit words - - /// @brief DOCME - /// @param val - /// @return - /// inline uint32_t MachineToBig(uint32_t val) { bytes32 pack; @@ -312,11 +230,6 @@ namespace Endian { return pack.word; } - - /// @brief DOCME - /// @param val - /// @return - /// inline uint32_t MachineToLittle(uint32_t val) { bytes32 pack; @@ -327,11 +240,6 @@ namespace Endian { return pack.word; } - - /// @brief DOCME - /// @param val - /// @return - /// inline uint32_t BigToMachine(uint32_t val) { bytes32 pack; @@ -343,11 +251,6 @@ namespace Endian { uint32_t(pack.byte[3]); } - - /// @brief DOCME - /// @param val - /// @return - /// inline uint32_t LittleToMachine(uint32_t val) { bytes32 pack; @@ -362,11 +265,6 @@ namespace Endian { // 64 bit words - - /// @brief DOCME - /// @param val - /// @return - /// inline uint64_t MachineToBig(uint64_t val) { bytes64 pack; @@ -381,11 +279,6 @@ namespace Endian { return pack.word; } - - /// @brief DOCME - /// @param val - /// @return - /// inline uint64_t MachineToLittle(uint64_t val) { bytes64 pack; @@ -400,11 +293,6 @@ namespace Endian { return pack.word; } - - /// @brief DOCME - /// @param val - /// @return - /// inline uint64_t BigToMachine(uint64_t val) { bytes64 pack; @@ -420,10 +308,6 @@ namespace Endian { uint64_t(pack.byte[7]); } - - /// @brief DOCME - /// @param val - /// inline uint64_t LittleToMachine(uint64_t val) { bytes64 pack; diff --git a/aegisub/src/aegisublocale.h b/aegisub/src/aegisublocale.h index 8c458729b..5ea878f61 100644 --- a/aegisub/src/aegisublocale.h +++ b/aegisub/src/aegisublocale.h @@ -36,11 +36,6 @@ class wxTranslations; -/// DOCME -/// @class AegisubLocale -/// @brief DOCME -/// -/// DOCME class AegisubLocale { wxString active_language; wxTranslations *GetTranslations(); diff --git a/aegisub/src/ass_attachment.h b/aegisub/src/ass_attachment.h index 3c6f1f573..d932fa07a 100644 --- a/aegisub/src/ass_attachment.h +++ b/aegisub/src/ass_attachment.h @@ -38,7 +38,6 @@ #include "ass_entry.h" /// @class AssAttachment -/// @brief DOCME class AssAttachment : public AssEntry { /// Decoded file data std::shared_ptr > data; diff --git a/aegisub/src/ass_export_filter.h b/aegisub/src/ass_export_filter.h index 54da5520e..bd74a5e37 100644 --- a/aegisub/src/ass_export_filter.h +++ b/aegisub/src/ass_export_filter.h @@ -47,11 +47,6 @@ namespace agi { struct Context; } typedef std::vector FilterList; -/// DOCME -/// @class AssExportFilterChain -/// @brief DOCME -/// -/// DOCME class AssExportFilterChain { static FilterList *filters(); public: @@ -68,11 +63,6 @@ public: static const FilterList *GetFilterList(); }; -/// DOCME -/// @class AssExportFilter -/// @brief DOCME -/// -/// DOCME class AssExportFilter { /// The filter chain needs to be able to muck around with filter names when /// they're registered to avoid duplicates diff --git a/aegisub/src/ass_exporter.h b/aegisub/src/ass_exporter.h index 7329216e8..ea2b350a7 100644 --- a/aegisub/src/ass_exporter.h +++ b/aegisub/src/ass_exporter.h @@ -45,11 +45,6 @@ namespace agi { struct Context; } typedef std::vector FilterList; -/// DOCME -/// @class AssExporter -/// @brief DOCME -/// -/// DOCME class AssExporter { typedef FilterList::const_iterator filter_iterator; diff --git a/aegisub/src/ass_file.h b/aegisub/src/ass_file.h index 67d89768f..066389c68 100644 --- a/aegisub/src/ass_file.h +++ b/aegisub/src/ass_file.h @@ -53,11 +53,6 @@ typedef boost::intrusive::make_list UndoStack; boost::container::list RedoStack; diff --git a/aegisub/src/ass_override.h b/aegisub/src/ass_override.h index b1461de98..a739a026a 100644 --- a/aegisub/src/ass_override.h +++ b/aegisub/src/ass_override.h @@ -65,9 +65,7 @@ enum AssParameterOptional { OPTIONAL_7 = 0x40 }; -/// DOCME -/// @class AssOverrideParameter -/// @brief A single parameter to an override tag +/// A single parameter to an override tag class AssOverrideParameter : public VariableData { public: /// Type of parameter @@ -81,9 +79,7 @@ public: void operator=(const AssOverrideParameter ¶m); }; -/// DOCME -/// @class AssOverrideParamProto -/// @brief Prototype of a single override parameter +/// Prototype of a single override parameter struct AssOverrideParamProto { /// ASS_ParameterOptional int optional; @@ -97,9 +93,6 @@ struct AssOverrideParamProto { AssOverrideParamProto (VariableDataType type, int opt=NOT_OPTIONAL, AssParameterClass classi=PARCLASS_NORMAL); }; -/// DOCME -/// @class AssOverrideTagProto -/// @brief DOCME struct AssOverrideTagProto { /// Name of the tag, with slash wxString name; @@ -120,17 +113,12 @@ struct AssOverrideTagProto { void Set(wxString name, VariableDataType type, AssParameterClass classi = PARCLASS_NORMAL, int opt = NOT_OPTIONAL); }; -/// DOCME -/// @class AssOverrideTag -/// @brief DOCME -/// -/// DOCME class AssOverrideTag { bool valid; public: wxString Name; - std::vector Params; + std::vector Params; AssOverrideTag(); AssOverrideTag(wxString text); diff --git a/aegisub/src/ass_style_storage.h b/aegisub/src/ass_style_storage.h index 532a5e31f..b2d45b6d2 100644 --- a/aegisub/src/ass_style_storage.h +++ b/aegisub/src/ass_style_storage.h @@ -38,11 +38,6 @@ class AssStyle; -/// DOCME -/// @class AssStyleStorage -/// @brief DOCME -/// -/// DOCME class AssStyleStorage { wxString storage_name; std::deque style; diff --git a/aegisub/src/ass_time.h b/aegisub/src/ass_time.h index 6849cc594..44e0372c7 100644 --- a/aegisub/src/ass_time.h +++ b/aegisub/src/ass_time.h @@ -38,11 +38,6 @@ #include -/// DOCME -/// @class AssTime -/// @brief DOCME -/// -/// DOCME class AssTime { /// Time in milliseconds int time; diff --git a/aegisub/src/audio_box.h b/aegisub/src/audio_box.h index 9761b2dce..1ca8275de 100644 --- a/aegisub/src/audio_box.h +++ b/aegisub/src/audio_box.h @@ -69,13 +69,8 @@ class AudioBox : public wxSashWindow { /// The audio display in the box AudioDisplay *audioDisplay; - /// DOCME wxSlider *HorizontalZoom; - - /// DOCME wxSlider *VerticalZoom; - - /// DOCME wxSlider *VolumeBar; // Mouse wheel zoom accumulator diff --git a/aegisub/src/audio_player_dsound.h b/aegisub/src/audio_player_dsound.h index 59adf9d66..ec97b58df 100644 --- a/aegisub/src/audio_player_dsound.h +++ b/aegisub/src/audio_player_dsound.h @@ -43,18 +43,8 @@ class DirectSoundPlayer; -/// DOCME -/// @class DirectSoundPlayerThread -/// @brief DOCME -/// -/// DOCME class DirectSoundPlayerThread : public wxThread { -private: - - /// DOCME DirectSoundPlayer *parent; - - /// DOCME HANDLE stopnotify; public: @@ -65,49 +55,23 @@ public: wxThread::ExitCode Entry(); }; -/// DOCME -/// @class DirectSoundPlayer -/// @brief DOCME -/// -/// DOCME class DirectSoundPlayer : public AudioPlayer { friend class DirectSoundPlayerThread; -private: - - /// DOCME volatile bool playing; - - /// DOCME float volume; - - /// DOCME int offset; - /// DOCME DWORD bufSize; - - /// DOCME volatile int64_t playPos; - - /// DOCME int64_t startPos; - - /// DOCME volatile int64_t endPos; - - /// DOCME DWORD startTime; - /// DOCME IDirectSound8 *directSound; - - /// DOCME IDirectSoundBuffer8 *buffer; bool FillBuffer(bool fill); - - /// DOCME DirectSoundPlayerThread *thread; public: diff --git a/aegisub/src/audio_player_openal.h b/aegisub/src/audio_player_openal.h index 8b478562b..0e2f4a1a1 100644 --- a/aegisub/src/audio_player_openal.h +++ b/aegisub/src/audio_player_openal.h @@ -51,11 +51,6 @@ #include -/// DOCME -/// @class OpenALPlayer -/// @brief DOCME -/// -/// DOCME class OpenALPlayer : public AudioPlayer, wxTimer { /// Number of OpenAL buffers to use static const ALsizei num_buffers = 8; @@ -87,7 +82,6 @@ class OpenALPlayer : public AudioPlayer, wxTimer { /// Number of buffers which have been fully played since playback was last started ALsizei buffers_played; - /// DOCME wxStopWatch playback_segment_timer; /// Buffer to decode audio into diff --git a/aegisub/src/audio_player_oss.h b/aegisub/src/audio_player_oss.h index 8673e0de7..ea515fa21 100644 --- a/aegisub/src/audio_player_oss.h +++ b/aegisub/src/audio_player_oss.h @@ -51,9 +51,7 @@ class AudioProvider; class OSSPlayer; -/// DOCME -/// @class OSSPlayerThread -/// @brief Worker thread to asynchronously write audio data to the output device +/// Worker thread to asynchronously write audio data to the output device class OSSPlayerThread : public wxThread { /// Parent player OSSPlayer *parent; @@ -67,11 +65,6 @@ public: wxThread::ExitCode Entry(); }; -/// DOCME -/// @class OSSPlayer -/// @brief DOCME -/// -/// DOCME class OSSPlayer : public AudioPlayer { friend class OSSPlayerThread; diff --git a/aegisub/src/audio_player_pulse.h b/aegisub/src/audio_player_pulse.h index 9ce93c0e3..e4ba1e194 100644 --- a/aegisub/src/audio_player_pulse.h +++ b/aegisub/src/audio_player_pulse.h @@ -39,81 +39,45 @@ class PulseAudioPlayer; -/// DOCME -/// @class PulseAudioPlayer -/// @brief DOCME -/// -/// DOCME class PulseAudioPlayer : public AudioPlayer { - /// DOCME float volume; - - /// DOCME bool is_playing; - - /// DOCME volatile unsigned long start_frame; - - /// DOCME volatile unsigned long cur_frame; - - /// DOCME volatile unsigned long end_frame; - /// DOCME unsigned long bpf; // bytes per frame - /// DOCME wxSemaphore context_notify; - - /// DOCME wxSemaphore context_success; - - /// DOCME volatile int context_success_val; - /// DOCME wxSemaphore stream_notify; - - /// DOCME wxSemaphore stream_success; - - /// DOCME volatile int stream_success_val; - - /// DOCME pa_threaded_mainloop *mainloop; // pulseaudio mainloop handle - - /// DOCME pa_context *context; // connection context - - /// DOCME volatile pa_context_state_t cstate; - /// DOCME pa_stream *stream; - - /// DOCME volatile pa_stream_state_t sstate; - /// DOCME volatile pa_usec_t play_start_time; // timestamp when playback was started - /// DOCME int paerror; - // Called by PA to notify about contetxt operation completion + /// Called by PA to notify about contetxt operation completion static void pa_context_success(pa_context *c, int success, PulseAudioPlayer *thread); - // Called by PA to notify about other context-related stuff + /// Called by PA to notify about other context-related stuff static void pa_context_notify(pa_context *c, PulseAudioPlayer *thread); - // Called by PA when a stream operation completes + /// Called by PA when a stream operation completes static void pa_stream_success(pa_stream *p, int success, PulseAudioPlayer *thread); - // Called by PA to request more data written to stream + /// Called by PA to request more data written to stream static void pa_stream_write(pa_stream *p, size_t length, PulseAudioPlayer *thread); - // Called by PA to notify about other stream-related stuff + /// Called by PA to notify about other stream-related stuff static void pa_stream_notify(pa_stream *p, PulseAudioPlayer *thread); public: diff --git a/aegisub/src/audio_provider_avs.h b/aegisub/src/audio_provider_avs.h index bd8906b71..8bf51dfdc 100644 --- a/aegisub/src/audio_provider_avs.h +++ b/aegisub/src/audio_provider_avs.h @@ -38,19 +38,10 @@ #include "avisynth.h" #include "avisynth_wrap.h" - -/// DOCME -/// @class AvisynthAudioProvider -/// @brief DOCME -/// -/// DOCME class AvisynthAudioProvider : public AudioProvider { AviSynthWrapper avs_wrapper; - /// DOCME wxString filename; - - /// DOCME PClip clip; void LoadFromClip(AVSValue clip); diff --git a/aegisub/src/audio_provider_dummy.h b/aegisub/src/audio_provider_dummy.h index b1a57ffd6..0fcbdd64c 100644 --- a/aegisub/src/audio_provider_dummy.h +++ b/aegisub/src/audio_provider_dummy.h @@ -34,13 +34,7 @@ #include "include/aegisub/audio_provider.h" -/// DOCME -/// @class DummyAudioProvider -/// @brief DOCME -/// -/// DOCME class DummyAudioProvider : public AudioProvider { - /// DOCME bool noise; void FillBuffer(void *buf, int64_t start, int64_t count) const; diff --git a/aegisub/src/audio_provider_hd.h b/aegisub/src/audio_provider_hd.h index f2aae912a..1f878702a 100644 --- a/aegisub/src/audio_provider_hd.h +++ b/aegisub/src/audio_provider_hd.h @@ -43,11 +43,6 @@ namespace agi { class ProgressSink; } -/// DOCME -/// @class HDAudioProvider -/// @brief DOCME -/// -/// DOCME class HDAudioProvider : public AudioProvider { /// Name of the file which the decoded audio is written to wxString diskCacheFilename; diff --git a/aegisub/src/audio_provider_pcm.cpp b/aegisub/src/audio_provider_pcm.cpp index 7f92db21f..7de12992c 100644 --- a/aegisub/src/audio_provider_pcm.cpp +++ b/aegisub/src/audio_provider_pcm.cpp @@ -214,13 +214,11 @@ void PCMAudioProvider::FillBuffer(void *buf, int64_t start, int64_t count) const } } -/// DOCME /// @class RiffWavPCMAudioProvider /// @brief RIFF WAV PCM provider /// /// Overview of RIFF WAV: class RiffWavPCMAudioProvider : public PCMAudioProvider { - /// DOCME struct ChunkHeader { /// Always "RIFF" char type[4]; @@ -228,19 +226,13 @@ class RiffWavPCMAudioProvider : public PCMAudioProvider { uint32_t size; }; - /// DOCME struct RIFFChunk { - - /// DOCME ChunkHeader ch; - /// Always "WAVE" char format[4]; }; - /// DOCME struct fmtChunk { - /// compression format used /// We support only PCM (0x1) uint16_t compression; @@ -383,7 +375,6 @@ static const uint8_t w64Guiddata[16] = { 0x64, 0x61, 0x74, 0x61, 0xF3, 0xAC, 0xD3, 0x11, 0x8C, 0xD1, 0x00, 0xC0, 0x4F, 0x8E, 0xDB, 0x8A }; -/// DOCME /// @class Wave64AudioProvider /// @brief Sony Wave64 audio provider /// diff --git a/aegisub/src/audio_provider_pcm.h b/aegisub/src/audio_provider_pcm.h index 6c29a0aaf..758129cff 100644 --- a/aegisub/src/audio_provider_pcm.h +++ b/aegisub/src/audio_provider_pcm.h @@ -46,11 +46,6 @@ #include -/// DOCME -/// @class PCMAudioProvider -/// @brief DOCME -/// -/// DOCME class PCMAudioProvider : public AudioProvider { mutable void *current_mapping; diff --git a/aegisub/src/audio_provider_ram.h b/aegisub/src/audio_provider_ram.h index 190d9f4e7..43a282458 100644 --- a/aegisub/src/audio_provider_ram.h +++ b/aegisub/src/audio_provider_ram.h @@ -39,19 +39,9 @@ namespace agi { class ProgressSink; } -/// DOCME -/// @class RAMAudioProvider -/// @brief DOCME -/// -/// DOCME class RAMAudioProvider : public AudioProvider { - /// DOCME char** blockcache; - - /// DOCME int blockcount; - - /// DOCME bool samples_native_endian; void Clear(); diff --git a/aegisub/src/auto4_base.cpp b/aegisub/src/auto4_base.cpp index e553b0f80..38a9b14f1 100644 --- a/aegisub/src/auto4_base.cpp +++ b/aegisub/src/auto4_base.cpp @@ -71,7 +71,6 @@ #include "subtitle_format.h" #include "utils.h" -/// DOCME namespace Automation4 { bool CalculateTextExtents(AssStyle *style, wxString const& text, double &width, double &height, double &descent, double &extlead) { diff --git a/aegisub/src/auto4_base.h b/aegisub/src/auto4_base.h index 97d5a037f..c63c1960a 100644 --- a/aegisub/src/auto4_base.h +++ b/aegisub/src/auto4_base.h @@ -65,8 +65,6 @@ class wxPathList; namespace agi { struct Context; } namespace cmd { class Command; } - -/// DOCME namespace Automation4 { DEFINE_BASE_EXCEPTION_NOINNER(AutomationError, agi::Exception) DEFINE_SIMPLE_EXCEPTION_NOINNER(ScriptLoadError, AutomationError, "automation/load/generic") diff --git a/aegisub/src/auto4_lua_factory.h b/aegisub/src/auto4_lua_factory.h index 6f0848ef1..a2411f844 100644 --- a/aegisub/src/auto4_lua_factory.h +++ b/aegisub/src/auto4_lua_factory.h @@ -35,11 +35,6 @@ #include "auto4_base.h" namespace Automation4 { - /// DOCME - /// @class LuaScriptFactory - /// @brief DOCME - /// - /// DOCME class LuaScriptFactory : public ScriptFactory { Script* Produce(const wxString &filename) const; public: diff --git a/aegisub/src/avisynth_wrap.h b/aegisub/src/avisynth_wrap.h index 48d1e2a7b..d4e5b2e2a 100644 --- a/aegisub/src/avisynth_wrap.h +++ b/aegisub/src/avisynth_wrap.h @@ -36,11 +36,6 @@ class IScriptEnvironment; -/// DOCME -/// @class AviSynthWrapper -/// @brief DOCME -/// -/// DOCME class AviSynthWrapper { AviSynthWrapper(AviSynthWrapper const&); public: diff --git a/aegisub/src/base_grid.h b/aegisub/src/base_grid.h index 23c65d996..8f20cfbcd 100644 --- a/aegisub/src/base_grid.h +++ b/aegisub/src/base_grid.h @@ -51,11 +51,6 @@ namespace agi { } class AssDialogue; -/// DOCME -/// @class BaseGrid -/// @brief DOCME -/// -/// DOCME class BaseGrid : public wxWindow, public SubtitleSelectionController { int lineHeight; ///< Height of a line in pixels in the current font bool holding; ///< Is a drag selection in process? diff --git a/aegisub/src/block_cache.h b/aegisub/src/block_cache.h index 6a926fb74..8e5568c65 100644 --- a/aegisub/src/block_cache.h +++ b/aegisub/src/block_cache.h @@ -98,7 +98,6 @@ class DataBlockCache { /// Type of an array of blocks typedef std::vector BlockArray; - /// DOCME struct MacroBlock { /// This macroblock's position in the age list /// Is valid iff blocks.size() > 0 diff --git a/aegisub/src/dialog_attachments.h b/aegisub/src/dialog_attachments.h index a85959128..a90288a07 100644 --- a/aegisub/src/dialog_attachments.h +++ b/aegisub/src/dialog_attachments.h @@ -41,21 +41,11 @@ class wxListEvent; #include "ass_entry.h" -/// DOCME -/// @class DialogAttachments -/// @brief DOCME -/// -/// DOCME class DialogAttachments : public wxDialog { AssFile *ass; - /// DOCME wxListView *listView; - - /// DOCME wxButton *extractButton; - - /// DOCME wxButton *deleteButton; void OnAttachFont(wxCommandEvent &event); diff --git a/aegisub/src/dialog_automation.h b/aegisub/src/dialog_automation.h index 2843cb014..a9b7d2c78 100644 --- a/aegisub/src/dialog_automation.h +++ b/aegisub/src/dialog_automation.h @@ -50,11 +50,6 @@ class wxButton; class wxListEvent; class wxListView; -/// DOCME -/// @class DialogAutomation -/// @brief DOCME -/// -/// DOCME class DialogAutomation : public wxDialog { agi::Context *context; diff --git a/aegisub/src/dialog_colorpicker.cpp b/aegisub/src/dialog_colorpicker.cpp index 61624b855..c6fa212ef 100644 --- a/aegisub/src/dialog_colorpicker.cpp +++ b/aegisub/src/dialog_colorpicker.cpp @@ -190,16 +190,13 @@ class DialogColorPicker : public wxDialog { /// click the eyedropper or drag the eyedropper wxPoint eyedropper_grab_point; - /// DOCME bool eyedropper_is_grabbed; wxStaticBitmap *preview_box; ///< A box which simply shows the current color ColorPickerRecent *recent_box; ///< A grid of recently used colors - /// DOCME ColorPickerScreenDropper *screen_dropper; - /// DOCME wxStaticBitmap *screen_dropper_icon; /// Update all other controls as a result of modifying an RGB control diff --git a/aegisub/src/dialog_detached_video.h b/aegisub/src/dialog_detached_video.h index 607833c0e..ff58af15a 100644 --- a/aegisub/src/dialog_detached_video.h +++ b/aegisub/src/dialog_detached_video.h @@ -42,11 +42,6 @@ class PersistLocation; class VideoBox; class VideoDisplay; -/// DOCME -/// @class DialogDetachedVideo -/// @brief DOCME -/// -/// DOCME class DialogDetachedVideo : public wxDialog { agi::Context *context; VideoDisplay *old_display; diff --git a/aegisub/src/dialog_dummy_video.cpp b/aegisub/src/dialog_dummy_video.cpp index 427d9f4e9..b44a366a5 100644 --- a/aegisub/src/dialog_dummy_video.cpp +++ b/aegisub/src/dialog_dummy_video.cpp @@ -64,14 +64,12 @@ enum { Dummy_Video_Length }; -/// DOCME struct ResolutionShortcut { const char *name; int width; int height; }; -/// DOCME static ResolutionShortcut resolutions[] = { {"640x480 (SD fullscreen)", 640, 480}, {"704x480 (SD anamorphic)", 704, 480}, diff --git a/aegisub/src/dialog_dummy_video.h b/aegisub/src/dialog_dummy_video.h index 3da9a77eb..2b8b05066 100644 --- a/aegisub/src/dialog_dummy_video.h +++ b/aegisub/src/dialog_dummy_video.h @@ -42,11 +42,6 @@ class wxSpinCtrl; class wxStaticText; class wxTextCtrl; -/// DOCME -/// @class DialogDummyVideo -/// @brief DOCME -/// -/// DOCME class DialogDummyVideo : public wxDialog { DialogDummyVideo(wxWindow *parent); ~DialogDummyVideo(); diff --git a/aegisub/src/dialog_export.h b/aegisub/src/dialog_export.h index 8c92b89ee..f2d2a76c5 100644 --- a/aegisub/src/dialog_export.h +++ b/aegisub/src/dialog_export.h @@ -47,11 +47,6 @@ class AssExporter; namespace agi { struct Context; } -/// DOCME -/// @class DialogExport -/// @brief DOCME -/// -/// DOCME class DialogExport : public wxDialog { agi::Context *c; @@ -67,7 +62,6 @@ class DialogExport : public wxDialog { /// A list of available target charsets wxChoice *charset_list; - /// DOCME wxSizer *opt_sizer; void OnProcess(wxCommandEvent &); diff --git a/aegisub/src/dialog_fonts_collector.h b/aegisub/src/dialog_fonts_collector.h index 9b1bfd5f6..930c41e70 100644 --- a/aegisub/src/dialog_fonts_collector.h +++ b/aegisub/src/dialog_fonts_collector.h @@ -31,11 +31,6 @@ class wxStaticText; class wxTextCtrl; class wxThreadEvent; -/// DOCME -/// @class DialogFontsCollector -/// @brief DOCME -/// -/// DOCME class DialogFontsCollector : public wxDialog { AssFile *subs; diff --git a/aegisub/src/dialog_jumpto.h b/aegisub/src/dialog_jumpto.h index d7537a543..e5c0fa443 100644 --- a/aegisub/src/dialog_jumpto.h +++ b/aegisub/src/dialog_jumpto.h @@ -35,11 +35,6 @@ class TimeEdit; namespace agi { struct Context; } -/// DOCME -/// @class DialogJumpTo -/// @brief DOCME -/// -/// DOCME class DialogJumpTo : public wxDialog { agi::Context *c; ///< Project context long jumpframe; ///< Target frame to jump to diff --git a/aegisub/src/dialog_kara_timing_copy.cpp b/aegisub/src/dialog_kara_timing_copy.cpp index 382cf4de2..dff3c8ae6 100644 --- a/aegisub/src/dialog_kara_timing_copy.cpp +++ b/aegisub/src/dialog_kara_timing_copy.cpp @@ -75,11 +75,6 @@ enum { BUTTON_KTACCEPT }; -/// DOCME -/// @class KaraokeLineMatchDisplay -/// @brief DOCME -/// -/// DOCME class KaraokeLineMatchDisplay : public wxControl { typedef AssKaraoke::Syllable MatchSyllable; diff --git a/aegisub/src/dialog_kara_timing_copy.h b/aegisub/src/dialog_kara_timing_copy.h index baa78272b..e4c0ed431 100644 --- a/aegisub/src/dialog_kara_timing_copy.h +++ b/aegisub/src/dialog_kara_timing_copy.h @@ -45,11 +45,6 @@ class KaraokeLineMatchDisplay; class wxComboBox; class wxCheckBox; -/// DOCME -/// @class DialogKanjiTimer -/// @brief DOCME -/// -/// DOCME class DialogKanjiTimer : public wxDialog { AssFile *subs; diff --git a/aegisub/src/dialog_paste_over.h b/aegisub/src/dialog_paste_over.h index e970fc5ad..652dad418 100644 --- a/aegisub/src/dialog_paste_over.h +++ b/aegisub/src/dialog_paste_over.h @@ -36,11 +36,6 @@ class wxCheckListBox; -/// DOCME -/// @class DialogPasteOver -/// @brief DOCME -/// -/// DOCME class DialogPasteOver : public wxDialog { wxCheckListBox *ListBox; diff --git a/aegisub/src/dialog_properties.h b/aegisub/src/dialog_properties.h index 72f516d6b..8196fc83c 100644 --- a/aegisub/src/dialog_properties.h +++ b/aegisub/src/dialog_properties.h @@ -41,11 +41,6 @@ class AssFile; namespace agi { struct Context; } -/// DOCME -/// @class DialogProperties -/// @brief DOCME -/// -/// DOCME class DialogProperties : public wxDialog { agi::Context *c; ///< Project this dialog is adjusting the properties of diff --git a/aegisub/src/dialog_selection.h b/aegisub/src/dialog_selection.h index a7e477478..947261a63 100644 --- a/aegisub/src/dialog_selection.h +++ b/aegisub/src/dialog_selection.h @@ -28,11 +28,6 @@ class wxRadioBox; class wxRadioButton; class wxTextCtrl; -/// DOCME -/// @class DialogSelection -/// @brief DOCME -/// -/// DOCME class DialogSelection : public wxDialog { agi::Context *con; ///< Project context diff --git a/aegisub/src/dialog_shift_times.h b/aegisub/src/dialog_shift_times.h index 2efc8179f..124b04872 100644 --- a/aegisub/src/dialog_shift_times.h +++ b/aegisub/src/dialog_shift_times.h @@ -41,11 +41,6 @@ namespace json { typedef std::deque Array; } -/// DOCME -/// @class DialogShiftTimes -/// @brief DOCME -/// -/// DOCME class DialogShiftTimes : public wxDialog { agi::Context *context; diff --git a/aegisub/src/dialog_spellchecker.h b/aegisub/src/dialog_spellchecker.h index 0d06e9100..c14a94903 100644 --- a/aegisub/src/dialog_spellchecker.h +++ b/aegisub/src/dialog_spellchecker.h @@ -36,11 +36,6 @@ class wxComboBox; class wxListBox; class wxTextCtrl; -/// DOCME -/// @class DialogSpellChecker -/// @brief DOCME -/// -/// DOCME class DialogSpellChecker : public wxDialog { agi::Context *context; ///< The project context agi::scoped_ptr spellchecker; ///< The spellchecking engine diff --git a/aegisub/src/dialog_style_editor.h b/aegisub/src/dialog_style_editor.h index 797786078..c2e39c515 100644 --- a/aegisub/src/dialog_style_editor.h +++ b/aegisub/src/dialog_style_editor.h @@ -47,11 +47,6 @@ class ColourButton; class PersistLocation; class SubtitlesPreview; -/// DOCME -/// @class DialogStyleEditor -/// @brief DOCME -/// -/// DOCME class DialogStyleEditor : public wxDialog { agi::Context *c; agi::scoped_ptr persist; @@ -61,76 +56,36 @@ class DialogStyleEditor : public wxDialog { /// the style bool is_new; - /// DOCME + /// The style currently being edited AssStyle *style; - /// DOCME + /// Copy of style passed to the subtitles preview to avoid making changes + /// before Apply is clicked agi::scoped_ptr work; - /// DOCME + /// The style storage style is in, if applicable AssStyleStorage *store; - /// DOCME wxTextCtrl *StyleName; - - /// DOCME wxComboBox *FontName; - - /// DOCME wxTextCtrl *FontSize; - - /// DOCME wxCheckBox *BoxBold; - - /// DOCME wxCheckBox *BoxItalic; - - /// DOCME wxCheckBox *BoxUnderline; - - /// DOCME wxCheckBox *BoxStrikeout; - - /// DOCME ColourButton *colorButton[4]; - - /// DOCME wxSpinCtrl *colorAlpha[4]; - - /// DOCME wxSpinCtrl *margin[3]; - - /// DOCME wxRadioBox *Alignment; - - /// DOCME wxTextCtrl *Outline; - - /// DOCME wxTextCtrl *Shadow; - - /// DOCME wxCheckBox *OutlineType; - - /// DOCME wxTextCtrl *ScaleX; - - /// DOCME wxTextCtrl *ScaleY; - - /// DOCME wxTextCtrl *Angle; - - /// DOCME wxComboBox *Encoding; - - /// DOCME wxTextCtrl *Spacing; - - /// DOCME wxTextCtrl *PreviewText; - - /// DOCME SubtitlesPreview *SubsPreview; void SetBitmapColor(int n,wxColour color); diff --git a/aegisub/src/dialog_style_manager.h b/aegisub/src/dialog_style_manager.h index bb6e9e03c..01ff184ed 100644 --- a/aegisub/src/dialog_style_manager.h +++ b/aegisub/src/dialog_style_manager.h @@ -51,11 +51,6 @@ class AssStyle; class DialogStyleEditor; class PersistLocation; -/// DOCME -/// @class DialogStyleManager -/// @brief DOCME -/// -/// DOCME class DialogStyleManager : public wxDialog { agi::Context *c; ///< Project context agi::scoped_ptr persist; diff --git a/aegisub/src/dialog_styling_assistant.h b/aegisub/src/dialog_styling_assistant.h index a33d7a339..5fa267f53 100644 --- a/aegisub/src/dialog_styling_assistant.h +++ b/aegisub/src/dialog_styling_assistant.h @@ -34,11 +34,6 @@ class wxCheckBox; class wxListBox; class wxTextCtrl; -/// DOCME -/// @class DialogStyling -/// @brief DOCME -/// -/// DOCME class DialogStyling : public wxDialog { agi::Context *c; agi::signal::Connection active_line_connection; diff --git a/aegisub/src/dialog_translation.h b/aegisub/src/dialog_translation.h index 54f3c5d8a..1ea962a5d 100644 --- a/aegisub/src/dialog_translation.h +++ b/aegisub/src/dialog_translation.h @@ -35,10 +35,7 @@ class SubsTextEditCtrl; class wxStaticText; class wxCheckBox; -/// @class DialogTranslation -/// @brief Assistant for translating subtitles in one language to another language -/// -/// DOCME +/// Assistant for translating subtitles in one language to another language class DialogTranslation : public wxDialog { agi::Context *c; diff --git a/aegisub/src/fft.cpp b/aegisub/src/fft.cpp index 73ff910ef..d3120793c 100644 --- a/aegisub/src/fft.cpp +++ b/aegisub/src/fft.cpp @@ -36,20 +36,11 @@ #include "config.h" -#include - #include "fft.h" +#include -/// @brief Transform -/// @param n_samples -/// @param input -/// @param output_r -/// @param output_i -/// @param inverse -/// void FFT::DoTransform (size_t n_samples,float *input,float *output_r,float *output_i,bool inverse) { - // Check if it's power of two if (!IsPowerOfTwo(n_samples)) { throw "FFT requires power of two input."; } @@ -127,47 +118,22 @@ void FFT::DoTransform (size_t n_samples,float *input,float *output_r,float *outp } } - - -/// @brief Transform wrappers -/// @param n_samples -/// @param input -/// @param output_r -/// @param output_i -/// void FFT::Transform(size_t n_samples,float *input,float *output_r,float *output_i) { DoTransform(n_samples,input,output_r,output_i,false); } - -/// @brief DOCME -/// @param n_samples -/// @param input -/// @param output_r -/// @param output_i -/// void FFT::InverseTransform(size_t n_samples,float *input,float *output_r,float *output_i) { DoTransform(n_samples,input,output_r,output_i,true); } - - /// @brief Checks if number is a power of two -/// @param x -/// @return -/// bool FFT::IsPowerOfTwo (unsigned int x) { if (x < 2) return false; if (x & (x-1)) return false; return true; } - - /// @brief Bits needed by the FFT -/// @param n_samples -/// @return -/// unsigned int FFT::NumberOfBitsNeeded (unsigned int n_samples) { int i; @@ -180,13 +146,7 @@ unsigned int FFT::NumberOfBitsNeeded (unsigned int n_samples) { } } - - /// @brief Get reversed bit position -/// @param index -/// @param bits -/// @return -/// unsigned int FFT::ReverseBits (unsigned int index, unsigned int bits) { unsigned int i, rev; @@ -198,13 +158,7 @@ unsigned int FFT::ReverseBits (unsigned int index, unsigned int bits) { return rev; } - - /// @brief Get frequency at index -/// @param baseFreq -/// @param n_samples -/// @param index -/// float FFT::FrequencyAtIndex (unsigned int baseFreq, unsigned int n_samples, unsigned int index) { if (index >= n_samples) return 0.0; else if (index <= n_samples/2) { @@ -214,5 +168,3 @@ float FFT::FrequencyAtIndex (unsigned int baseFreq, unsigned int n_samples, unsi return (-(float)(n_samples-index) / (float)n_samples * baseFreq); } } - - diff --git a/aegisub/src/fft.h b/aegisub/src/fft.h index 48b8462ef..0763af846 100644 --- a/aegisub/src/fft.h +++ b/aegisub/src/fft.h @@ -32,19 +32,9 @@ /// @ingroup utility /// +#include - - -#include // size_t - - -/// DOCME -/// @class FFT -/// @brief DOCME -/// -/// DOCME class FFT { -private: void DoTransform(size_t n_samples,float *input,float *output_r,float *output_i,bool inverse); public: diff --git a/aegisub/src/frame_main.h b/aegisub/src/frame_main.h index dc38637fe..2ee78ab0f 100644 --- a/aegisub/src/frame_main.h +++ b/aegisub/src/frame_main.h @@ -60,11 +60,6 @@ class VideoZoomSlider; namespace agi { struct Context; class OptionValue; } -/// DOCME -/// @class FrameMain -/// @brief DOCME -/// -/// DOCME class FrameMain: public wxFrame { friend class AegisubFileDropTarget; diff --git a/aegisub/src/gl_text.cpp b/aegisub/src/gl_text.cpp index 1b14e37ee..4f44d52ca 100644 --- a/aegisub/src/gl_text.cpp +++ b/aegisub/src/gl_text.cpp @@ -360,7 +360,6 @@ void OpenGLTextGlyph::Draw(float x, float y) const { glDisableClientState(GL_TEXTURE_COORD_ARRAY); } -/// @brief DOCME OpenGLTextGlyph::OpenGLTextGlyph(int value, wxFont const& font) : str(wxChar(value)) , tex(0) diff --git a/aegisub/src/gl_text.h b/aegisub/src/gl_text.h index 3ac080138..b84a92518 100644 --- a/aegisub/src/gl_text.h +++ b/aegisub/src/gl_text.h @@ -43,47 +43,20 @@ struct OpenGLTextGlyph; class OpenGLTextTexture; -/// DOCME typedef boost::container::map glyphMap; -/// DOCME -/// @class OpenGLText -/// @brief DOCME -/// -/// DOCME class OpenGLText { - /// DOCME - - /// DOCME - - /// DOCME - - /// DOCME float r,g,b,a; - /// DOCME int lineHeight; - - /// DOCME int fontSize; - - /// DOCME bool fontBold; - - /// DOCME bool fontItalics; - - /// DOCME wxString fontFace; - - /// DOCME wxFont font; - - /// DOCME glyphMap glyphs; - /// DOCME std::vector > textures; OpenGLText(OpenGLText const&); diff --git a/aegisub/src/gl_wrap.h b/aegisub/src/gl_wrap.h index b870f9abb..772acd1c6 100644 --- a/aegisub/src/gl_wrap.h +++ b/aegisub/src/gl_wrap.h @@ -25,11 +25,6 @@ class wxColour; -/// DOCME -/// @class OpenGLWrapper -/// @brief DOCME -/// -/// DOCME class OpenGLWrapper { float line_r, line_g, line_b, line_a; float fill_r, fill_g, fill_b, fill_a; diff --git a/aegisub/src/help_button.h b/aegisub/src/help_button.h index f1ad1239f..bb07f9d63 100644 --- a/aegisub/src/help_button.h +++ b/aegisub/src/help_button.h @@ -32,14 +32,8 @@ /// @ingroup custom_control /// - #include -/// DOCME -/// @class HelpButton -/// @brief DOCME -/// -/// DOCME class HelpButton : public wxButton { public: HelpButton(wxWindow *parent, wxString const& page="", wxPoint position=wxDefaultPosition, wxSize size=wxDefaultSize); diff --git a/aegisub/src/include/aegisub/audio_player.h b/aegisub/src/include/aegisub/audio_player.h index 417fadc28..90de9bef8 100644 --- a/aegisub/src/include/aegisub/audio_player.h +++ b/aegisub/src/include/aegisub/audio_player.h @@ -38,13 +38,8 @@ class AudioProvider; -/// @class AudioPlayer -/// @brief DOCME -/// -/// DOCME class AudioPlayer { protected: - /// DOCME AudioProvider *provider; public: diff --git a/aegisub/src/include/aegisub/audio_provider.h b/aegisub/src/include/aegisub/audio_provider.h index 7e401b40a..b29e52f13 100644 --- a/aegisub/src/include/aegisub/audio_provider.h +++ b/aegisub/src/include/aegisub/audio_provider.h @@ -39,28 +39,15 @@ #include #include "factory_manager.h" -/// @class AudioProvider -/// @brief DOCME -/// -/// DOCME class AudioProvider { protected: - /// DOCME int channels; /// for one channel, ie. number of PCM frames int64_t num_samples; - - /// DOCME int sample_rate; - - /// DOCME int bytes_per_sample; - bool float_samples; - - - /// DOCME wxString filename; virtual void FillBuffer(void *buf, int64_t start, int64_t count) const = 0; @@ -85,11 +72,6 @@ public: virtual bool NeedsCache() const { return false; } }; -/// DOCME -/// @class AudioProviderFactory -/// @brief DOCME -/// -/// DOCME class AudioProviderFactory : public Factory1 { public: static void RegisterProviders(); diff --git a/aegisub/src/include/aegisub/subtitles_provider.h b/aegisub/src/include/aegisub/subtitles_provider.h index ff3c3c1f7..f567c990c 100644 --- a/aegisub/src/include/aegisub/subtitles_provider.h +++ b/aegisub/src/include/aegisub/subtitles_provider.h @@ -39,28 +39,14 @@ class AssFile; class AegiVideoFrame; -/// @class SubtitlesProvider -/// @brief DOCME -/// -/// DOCME class SubtitlesProvider { public: virtual ~SubtitlesProvider() { }; virtual void LoadSubtitles(AssFile *subs)=0; - - /// @brief DOCME - /// @param dst - /// @param time - /// virtual void DrawSubtitles(AegiVideoFrame &dst,double time)=0; }; -/// DOCME -/// @class SubtitlesProviderFactoryManager -/// @brief DOCME -/// -/// DOCME class SubtitlesProviderFactory : public Factory1 { public: static SubtitlesProvider *GetProvider(); diff --git a/aegisub/src/include/aegisub/video_provider.h b/aegisub/src/include/aegisub/video_provider.h index 68b648267..aabfbc8aa 100644 --- a/aegisub/src/include/aegisub/video_provider.h +++ b/aegisub/src/include/aegisub/video_provider.h @@ -41,15 +41,11 @@ class AegiVideoFrame; -/// @class VideoProvider -/// @brief DOCME -/// -/// DOCME class VideoProvider { public: virtual ~VideoProvider() {} - // Override this method to actually get frames + /// Override this method to actually get frames virtual const AegiVideoFrame GetFrame(int n)=0; // Override the following methods to get video information: diff --git a/aegisub/src/main.cpp b/aegisub/src/main.cpp index 1348526cb..df78850eb 100644 --- a/aegisub/src/main.cpp +++ b/aegisub/src/main.cpp @@ -95,7 +95,6 @@ static const char *LastStartupState = nullptr; #ifdef __VISUALC__ -/// DOCME #define MS_VC_EXCEPTION 0x406d1388 /// Parameters for setting the thread name diff --git a/aegisub/src/mkv_wrap.h b/aegisub/src/mkv_wrap.h index 8007a0953..83c13f8bc 100644 --- a/aegisub/src/mkv_wrap.h +++ b/aegisub/src/mkv_wrap.h @@ -41,11 +41,6 @@ DEFINE_SIMPLE_EXCEPTION_NOINNER(MatroskaException, agi::Exception, "matroksa_wra class AssFile; -/// DOCME -/// @class MatroskaWrapper -/// @brief DOCME -/// -/// DOCME class MatroskaWrapper { public: /// Check if the file is a matroska file with at least one subtitle track diff --git a/aegisub/src/plugin_manager.cpp b/aegisub/src/plugin_manager.cpp index e5311af1f..d78bfa3c0 100644 --- a/aegisub/src/plugin_manager.cpp +++ b/aegisub/src/plugin_manager.cpp @@ -47,11 +47,7 @@ PluginManager::PluginManager() { init = false; - -#ifdef WITH_AUTO4_LUA lua = nullptr; -#endif - } PluginManager::~PluginManager() { diff --git a/aegisub/src/plugin_manager.h b/aegisub/src/plugin_manager.h index 3144b68bb..6e5cc671f 100644 --- a/aegisub/src/plugin_manager.h +++ b/aegisub/src/plugin_manager.h @@ -34,20 +34,9 @@ namespace Automation4 { class ScriptFactory; } -/// DOCME -/// @class PluginManager -/// @brief DOCME -/// -/// DOCME class PluginManager { -private: - - /// DOCME bool init; - -#ifdef WITH_AUTO4_LUA Automation4::ScriptFactory *lua; -#endif public: PluginManager(); @@ -55,5 +44,3 @@ public: void RegisterBuiltInPlugins(); }; - - diff --git a/aegisub/src/scintilla_text_ctrl.h b/aegisub/src/scintilla_text_ctrl.h index aeef47c32..171aee242 100644 --- a/aegisub/src/scintilla_text_ctrl.h +++ b/aegisub/src/scintilla_text_ctrl.h @@ -36,11 +36,6 @@ #include -/// DOCME -/// @class ScintillaTextCtrl -/// @brief DOCME -/// -/// DOCME class ScintillaTextCtrl : public wxStyledTextCtrl { wxString text; diff --git a/aegisub/src/spline.h b/aegisub/src/spline.h index 5ea4934ca..d6ac8e17a 100644 --- a/aegisub/src/spline.h +++ b/aegisub/src/spline.h @@ -41,9 +41,6 @@ class VisualToolBase; -/// DOCME -/// @class Spline -/// @brief DOCME class Spline : private std::list { /// Visual tool to do the conversion between script and video pixels const VisualToolBase &coord_translator; diff --git a/aegisub/src/spline_curve.h b/aegisub/src/spline_curve.h index 1a7cb8fa4..c6c3c0b35 100644 --- a/aegisub/src/spline_curve.h +++ b/aegisub/src/spline_curve.h @@ -36,11 +36,6 @@ #include -/// DOCME -/// @class SplineCurve -/// @brief DOCME -/// -/// DOCME class SplineCurve { /// Closest t in segment p1-p2 to point p3 float GetClosestSegmentPart(Vector2D p1, Vector2D p2, Vector2D p3) const; @@ -59,7 +54,6 @@ public: Vector2D p3; Vector2D p4; - /// DOCME CurveType type; SplineCurve(Vector2D p1 = Vector2D(0, 0)); diff --git a/aegisub/src/standard_paths.cpp b/aegisub/src/standard_paths.cpp index f75680b37..544ab4487 100644 --- a/aegisub/src/standard_paths.cpp +++ b/aegisub/src/standard_paths.cpp @@ -34,11 +34,11 @@ #include "config.h" +#include "standard_paths.h" + #include #include -#include "standard_paths.h" - StandardPaths &StandardPaths::GetInstance() { static StandardPaths instance; return instance; diff --git a/aegisub/src/standard_paths.h b/aegisub/src/standard_paths.h index 609b416ca..52ddb0981 100644 --- a/aegisub/src/standard_paths.h +++ b/aegisub/src/standard_paths.h @@ -33,18 +33,12 @@ /// #include +#include - -/// DOCME -/// @class StandardPaths -/// @brief DOCME -/// -/// DOCME class StandardPaths { static StandardPaths &GetInstance(); - /// DOCME - std::map paths; + std::map paths; StandardPaths(); StandardPaths(StandardPaths const&); diff --git a/aegisub/src/string_codec.cpp b/aegisub/src/string_codec.cpp index 2b1f6ceca..f53920635 100644 --- a/aegisub/src/string_codec.cpp +++ b/aegisub/src/string_codec.cpp @@ -39,10 +39,6 @@ #include "string_codec.h" -/// @brief DOCME -/// @param input -/// @return -/// wxString inline_string_encode(const wxString &input) { const size_t inlen = input.length(); @@ -59,10 +55,6 @@ wxString inline_string_encode(const wxString &input) return output; } - -/// @brief DOCME -/// @param input -/// wxString inline_string_decode(const wxString &input) { const size_t inlen = input.length(); @@ -86,5 +78,3 @@ wxString inline_string_decode(const wxString &input) } return output; } - - diff --git a/aegisub/src/string_codec.h b/aegisub/src/string_codec.h index d4b61db37..498d314b6 100644 --- a/aegisub/src/string_codec.h +++ b/aegisub/src/string_codec.h @@ -52,7 +52,6 @@ /// /// The encoded string should be usable in any kind of field in an ASS file. - #include wxString inline_string_encode(const wxString &input); diff --git a/aegisub/src/subs_edit_box.h b/aegisub/src/subs_edit_box.h index 869aa7316..f66f404d9 100644 --- a/aegisub/src/subs_edit_box.h +++ b/aegisub/src/subs_edit_box.h @@ -64,8 +64,6 @@ class wxTextCtrl; template class Placeholder; -/// DOCME -/// @class SubsEditBox /// @brief Main subtitle edit box /// /// Controls the text edit and all surrounding controls diff --git a/aegisub/src/subs_grid.h b/aegisub/src/subs_grid.h index 5d34eca69..c800fe538 100644 --- a/aegisub/src/subs_grid.h +++ b/aegisub/src/subs_grid.h @@ -36,11 +36,6 @@ #include -/// DOCME -/// @class SubtitlesGrid -/// @brief DOCME -/// -/// DOCME class SubtitlesGrid: public BaseGrid { public: SubtitlesGrid(wxWindow *parent, agi::Context *context); diff --git a/aegisub/src/subs_preview.h b/aegisub/src/subs_preview.h index 11c2ed53e..b3c7a1be8 100644 --- a/aegisub/src/subs_preview.h +++ b/aegisub/src/subs_preview.h @@ -42,9 +42,7 @@ class AssStyle; class SubtitlesProvider; class VideoProvider; -/// DOCME -/// @class SubtitlesPreview -/// @brief Preview window to show a short string with a given ass style +/// Preview window to show a short string with a given ass style class SubtitlesPreview : public wxWindow { /// The subtitle provider used to render the string agi::scoped_ptr provider; diff --git a/aegisub/src/subtitle_format.h b/aegisub/src/subtitle_format.h index 5ad7ed96b..62784b5c9 100644 --- a/aegisub/src/subtitle_format.h +++ b/aegisub/src/subtitle_format.h @@ -45,11 +45,6 @@ class AssEntry; class AssFile; namespace agi { namespace vfr { class Framerate; } } -/// DOCME -/// @class SubtitleFormat -/// @brief DOCME -/// -/// DOCME class SubtitleFormat { wxString name; diff --git a/aegisub/src/subtitle_format_ass.h b/aegisub/src/subtitle_format_ass.h index 6ea9e2f51..928901d83 100644 --- a/aegisub/src/subtitle_format_ass.h +++ b/aegisub/src/subtitle_format_ass.h @@ -34,11 +34,6 @@ #include "subtitle_format.h" -/// DOCME -/// @class ASSSubtitleFormat -/// @brief DOCME -/// -/// DOCME class AssSubtitleFormat : public SubtitleFormat { public: AssSubtitleFormat(); diff --git a/aegisub/src/subtitle_format_encore.h b/aegisub/src/subtitle_format_encore.h index ecf180ed9..57ccaa312 100644 --- a/aegisub/src/subtitle_format_encore.h +++ b/aegisub/src/subtitle_format_encore.h @@ -34,12 +34,6 @@ #include "subtitle_format.h" - -/// DOCME -/// @class EncoreSubtitleFormat -/// @brief DOCME -/// -/// DOCME class EncoreSubtitleFormat : public SubtitleFormat { public: EncoreSubtitleFormat(); diff --git a/aegisub/src/subtitle_format_microdvd.h b/aegisub/src/subtitle_format_microdvd.h index 3d68ccfce..054b6c75f 100644 --- a/aegisub/src/subtitle_format_microdvd.h +++ b/aegisub/src/subtitle_format_microdvd.h @@ -34,11 +34,6 @@ #include "subtitle_format.h" -/// DOCME -/// @class MicroDVDSubtitleFormat -/// @brief DOCME -/// -/// DOCME class MicroDVDSubtitleFormat : public SubtitleFormat { public: MicroDVDSubtitleFormat(); diff --git a/aegisub/src/subtitle_format_mkv.h b/aegisub/src/subtitle_format_mkv.h index 687bc28a6..e6d5b20c4 100644 --- a/aegisub/src/subtitle_format_mkv.h +++ b/aegisub/src/subtitle_format_mkv.h @@ -34,11 +34,6 @@ #include "subtitle_format.h" -/// DOCME -/// @class MKVSubtitleFormat -/// @brief DOCME -/// -/// DOCME class MKVSubtitleFormat : public SubtitleFormat { public: MKVSubtitleFormat(); diff --git a/aegisub/src/subtitle_format_srt.h b/aegisub/src/subtitle_format_srt.h index 1f8fdebd0..2205eabde 100644 --- a/aegisub/src/subtitle_format_srt.h +++ b/aegisub/src/subtitle_format_srt.h @@ -36,11 +36,6 @@ class AssDialogue; -/// DOCME -/// @class SRTSubtitleFormat -/// @brief DOCME -/// -/// DOCME class SRTSubtitleFormat : public SubtitleFormat { wxString ConvertTags(const AssDialogue *diag) const; public: diff --git a/aegisub/src/subtitle_format_transtation.h b/aegisub/src/subtitle_format_transtation.h index 19a7a8257..ce4154140 100644 --- a/aegisub/src/subtitle_format_transtation.h +++ b/aegisub/src/subtitle_format_transtation.h @@ -37,11 +37,6 @@ class AssDialogue; class SmpteFormatter; -/// DOCME -/// @class TranStationSubtitleFormat -/// @brief DOCME -/// -/// DOCME class TranStationSubtitleFormat : public SubtitleFormat { wxString ConvertLine(AssFile *file, AssDialogue *line, agi::vfr::Framerate const& fps, SmpteFormatter const& ft, int nextl_start) const; diff --git a/aegisub/src/subtitle_format_ttxt.h b/aegisub/src/subtitle_format_ttxt.h index 22cd3578e..100372cb4 100644 --- a/aegisub/src/subtitle_format_ttxt.h +++ b/aegisub/src/subtitle_format_ttxt.h @@ -37,11 +37,6 @@ class AssDialogue; class wxXmlNode; -/// DOCME -/// @class TTXTSubtitleFormat -/// @brief DOCME -/// -/// DOCME class TTXTSubtitleFormat : public SubtitleFormat { AssDialogue *ProcessLine(wxXmlNode *node, AssDialogue *prev, int version) const; void ProcessHeader(wxXmlNode *node) const; diff --git a/aegisub/src/subtitle_format_txt.h b/aegisub/src/subtitle_format_txt.h index 50a3444df..a73cd5a55 100644 --- a/aegisub/src/subtitle_format_txt.h +++ b/aegisub/src/subtitle_format_txt.h @@ -34,11 +34,6 @@ #include "subtitle_format.h" -/// DOCME -/// @class TXTSubtitleFormat -/// @brief DOCME -/// -/// DOCME class TXTSubtitleFormat : public SubtitleFormat { public: TXTSubtitleFormat(); diff --git a/aegisub/src/subtitles_provider_csri.h b/aegisub/src/subtitles_provider_csri.h index 34507f70d..6f460a670 100644 --- a/aegisub/src/subtitles_provider_csri.h +++ b/aegisub/src/subtitles_provider_csri.h @@ -43,11 +43,6 @@ typedef void csri_rend; typedef void csri_inst; -/// DOCME -/// @class CSRISubtitlesProvider -/// @brief DOCME -/// -/// DOCME class CSRISubtitlesProvider : public SubtitlesProvider { agi::scoped_holder instance; csri_rend *renderer; diff --git a/aegisub/src/subtitles_provider_libass.cpp b/aegisub/src/subtitles_provider_libass.cpp index 7f9d0badc..69fb43f65 100644 --- a/aegisub/src/subtitles_provider_libass.cpp +++ b/aegisub/src/subtitles_provider_libass.cpp @@ -56,9 +56,6 @@ #include "video_context.h" #include "video_frame.h" - -/// @brief Handle libass messages -/// static void msg_callback(int level, const char *fmt, va_list args, void *) { if (level >= 7) return; char buf[1024]; @@ -135,16 +132,11 @@ LibassSubtitlesProvider::LibassSubtitlesProvider(std::string) { wait_for_cache_thread(&cache_worker); } -/// @brief Destructor -/// LibassSubtitlesProvider::~LibassSubtitlesProvider() { if (ass_track) ass_free_track(ass_track); if (ass_renderer) ass_renderer_done(ass_renderer); } -/// @brief Load subtitles -/// @param subs -/// void LibassSubtitlesProvider::LoadSubtitles(AssFile *subs) { // Prepare subtitles std::vector data; @@ -156,24 +148,11 @@ void LibassSubtitlesProvider::LoadSubtitles(AssFile *subs) { if (!ass_track) throw "libass failed to load subtitles."; } -/// DOCME #define _r(c) ((c)>>24) - -/// DOCME #define _g(c) (((c)>>16)&0xFF) - -/// DOCME #define _b(c) (((c)>>8)&0xFF) - -/// DOCME #define _a(c) ((c)&0xFF) - -/// @brief Draw subtitles -/// @param frame -/// @param time -/// @return -/// void LibassSubtitlesProvider::DrawSubtitles(AegiVideoFrame &frame,double time) { // Set size ass_set_frame_size(ass_renderer, frame.w, frame.h); @@ -238,7 +217,6 @@ void LibassSubtitlesProvider::CacheFonts() { new FontConfigCacheThread(ass_library, &cache_worker); } -/// DOCME ASS_Library* LibassSubtitlesProvider::ass_library; FontConfigCacheThread* LibassSubtitlesProvider::cache_worker = nullptr; diff --git a/aegisub/src/subtitles_provider_libass.h b/aegisub/src/subtitles_provider_libass.h index 3fc14c91c..8e22200b2 100644 --- a/aegisub/src/subtitles_provider_libass.h +++ b/aegisub/src/subtitles_provider_libass.h @@ -45,19 +45,9 @@ extern "C" { class FontConfigCacheThread; -/// DOCME -/// @class LibassSubtitlesProvider -/// @brief DOCME -/// -/// DOCME class LibassSubtitlesProvider : public SubtitlesProvider { - /// DOCME static ASS_Library* ass_library; - - /// DOCME ASS_Renderer* ass_renderer; - - /// DOCME ASS_Track* ass_track; static FontConfigCacheThread *cache_worker; diff --git a/aegisub/src/text_file_writer.cpp b/aegisub/src/text_file_writer.cpp index 888cce31c..7a9d4d288 100644 --- a/aegisub/src/text_file_writer.cpp +++ b/aegisub/src/text_file_writer.cpp @@ -43,11 +43,6 @@ #include "main.h" #include "text_file_writer.h" - -/// @brief DOCME -/// @param filename -/// @param encoding -/// TextFileWriter::TextFileWriter(wxString const& filename, wxString encoding) : file(new agi::io::Save(STD_STR(filename), true)) , conv() diff --git a/aegisub/src/text_file_writer.h b/aegisub/src/text_file_writer.h index 25746abd3..7282d052d 100644 --- a/aegisub/src/text_file_writer.h +++ b/aegisub/src/text_file_writer.h @@ -39,27 +39,14 @@ #include namespace agi { - namespace charset { - class IconvWrapper; - } - namespace io { - class Save; - } + namespace charset { class IconvWrapper; } + namespace io { class Save; } } #include - -/// DOCME -/// @class TextFileWriter -/// @brief DOCME -/// -/// DOCME class TextFileWriter { - /// DOCME agi::scoped_ptr file; - - /// DOCME agi::scoped_ptr conv; public: diff --git a/aegisub/src/toggle_bitmap.h b/aegisub/src/toggle_bitmap.h index c44f57de5..d14d26389 100644 --- a/aegisub/src/toggle_bitmap.h +++ b/aegisub/src/toggle_bitmap.h @@ -38,11 +38,6 @@ namespace agi { struct Context; } namespace cmd { class Command; } -/// DOCME -/// @class ToggleBitmap -/// @brief DOCME -/// -/// DOCME class ToggleBitmap : public wxControl { agi::Context *context; cmd::Command &command; diff --git a/aegisub/src/tooltip_manager.h b/aegisub/src/tooltip_manager.h index 7f6c638cb..187ede62d 100644 --- a/aegisub/src/tooltip_manager.h +++ b/aegisub/src/tooltip_manager.h @@ -39,11 +39,6 @@ struct ToolTipBinding; class wxString; class wxWindow; -/// DOCME -/// @class ToolTipManager -/// @brief DOCME -/// -/// DOCME class ToolTipManager { ToolTipManager(); ~ToolTipManager(); diff --git a/aegisub/src/validators.h b/aegisub/src/validators.h index 745624aa2..18a0ba903 100644 --- a/aegisub/src/validators.h +++ b/aegisub/src/validators.h @@ -34,12 +34,7 @@ #include - -/// DOCME -/// @class NumValidator -/// @brief wx validator that only allows valid numbers -/// -/// DOCME +/// A wx validator that only allows valid numbers class NumValidator : public wxValidator { double fValue; ///< Value if isFloat is true int iValue; ///< Value if isFloat is false diff --git a/aegisub/src/vector2d.h b/aegisub/src/vector2d.h index 917f9f724..146192f11 100644 --- a/aegisub/src/vector2d.h +++ b/aegisub/src/vector2d.h @@ -25,11 +25,6 @@ #include -/// DOCME -/// @class Vector2D -/// @brief DOCME -/// -/// DOCME class Vector2D { float x, y; diff --git a/aegisub/src/video_display.h b/aegisub/src/video_display.h index 9388bfcc4..e0a5fbca8 100644 --- a/aegisub/src/video_display.h +++ b/aegisub/src/video_display.h @@ -60,8 +60,6 @@ namespace agi { class OptionValue; } -/// @class VideoDisplay -/// @brief DOCME class VideoDisplay : public wxGLCanvas { /// Signals the display is connected to std::deque slots; diff --git a/aegisub/src/video_frame.h b/aegisub/src/video_frame.h index 34081b6f1..5c778e16c 100644 --- a/aegisub/src/video_frame.h +++ b/aegisub/src/video_frame.h @@ -36,11 +36,6 @@ #include -/// DOCME -/// @class AegiVideoFrame -/// @brief DOCME -/// -/// DOCME class AegiVideoFrame { /// Whether the object owns its buffer. If this is false, **data should never be modified bool ownMem; diff --git a/aegisub/src/video_provider_avs.h b/aegisub/src/video_provider_avs.h index f178cae0c..f8630cd32 100644 --- a/aegisub/src/video_provider_avs.h +++ b/aegisub/src/video_provider_avs.h @@ -38,11 +38,6 @@ #include "include/aegisub/video_provider.h" #include "video_frame.h" -/// DOCME -/// @class AvisynthVideoProvider -/// @brief DOCME -/// -/// DOCME class AvisynthVideoProvider: public VideoProvider { AviSynthWrapper avs; AegiVideoFrame iframe; diff --git a/aegisub/src/visual_tool.h b/aegisub/src/visual_tool.h index 1efda453b..b0cca331b 100644 --- a/aegisub/src/visual_tool.h +++ b/aegisub/src/visual_tool.h @@ -154,9 +154,7 @@ public: virtual ~VisualToolBase(); }; -/// @class VisualTool -/// @brief Visual tool base class containing all common feature-related functionality -/// DOCME +/// Visual tool base class containing all common feature-related functionality template class VisualTool : public VisualToolBase { protected: diff --git a/aegisub/src/visual_tool_clip.h b/aegisub/src/visual_tool_clip.h index d6d4a236a..4da67e35c 100644 --- a/aegisub/src/visual_tool_clip.h +++ b/aegisub/src/visual_tool_clip.h @@ -22,19 +22,13 @@ #include "visual_feature.h" #include "visual_tool.h" -/// @class ClipCorner -/// @brief VisualDraggableFeature with siblings +/// VisualDraggableFeature with siblings struct ClipCorner : public VisualDraggableFeature { - ClipCorner *horiz; /// Other corner on this corner's horizontal line - ClipCorner *vert; /// Other corner on this corner's vertical line + ClipCorner *horiz; ///< Other corner on this corner's horizontal line + ClipCorner *vert; ///< Other corner on this corner's vertical line ClipCorner() : VisualDraggableFeature() , horiz(0) , vert(0) { } }; -/// DOCME -/// @class VisualToolClip -/// @brief DOCME -/// -/// DOCME class VisualToolClip : public VisualTool { Vector2D cur_1; Vector2D cur_2; diff --git a/aegisub/src/visual_tool_rotatexy.h b/aegisub/src/visual_tool_rotatexy.h index 1a93c6279..64c8d8d98 100644 --- a/aegisub/src/visual_tool_rotatexy.h +++ b/aegisub/src/visual_tool_rotatexy.h @@ -22,9 +22,6 @@ #include "visual_feature.h" #include "visual_tool.h" -/// DOCME -/// @class VisualToolRotateXY -/// @brief DOCME class VisualToolRotateXY : public VisualTool { float angle_x; /// Current x rotation float angle_y; /// Current y rotation diff --git a/aegisub/src/visual_tool_rotatez.h b/aegisub/src/visual_tool_rotatez.h index 08cddea84..9cdb627ba 100644 --- a/aegisub/src/visual_tool_rotatez.h +++ b/aegisub/src/visual_tool_rotatez.h @@ -22,11 +22,6 @@ #include "visual_feature.h" #include "visual_tool.h" -/// DOCME -/// @class VisualToolRotateZ -/// @brief DOCME -/// -/// DOCME class VisualToolRotateZ : public VisualTool { float angle; ///< Current Z rotation float orig_angle; ///< Z rotation at the beginning of the current hold diff --git a/aegisub/src/visual_tool_scale.h b/aegisub/src/visual_tool_scale.h index f9613b5ac..4b8b9989a 100644 --- a/aegisub/src/visual_tool_scale.h +++ b/aegisub/src/visual_tool_scale.h @@ -22,9 +22,6 @@ #include "visual_feature.h" #include "visual_tool.h" -/// DOCME -/// @class VisualToolScale -/// @brief DOCME class VisualToolScale : public VisualTool { Vector2D scale; ///< The current scale Vector2D initial_scale; ///< The scale at the beginning of the current hold diff --git a/aegisub/src/visual_tool_vector_clip.h b/aegisub/src/visual_tool_vector_clip.h index 3657e5cc3..22e160660 100644 --- a/aegisub/src/visual_tool_vector_clip.h +++ b/aegisub/src/visual_tool_vector_clip.h @@ -40,9 +40,6 @@ struct VisualToolVectorClipDraggableFeature : public VisualDraggableFeature { { } }; -/// DOCME -/// @class VisualToolVectorClip -/// @brief DOCME class VisualToolVectorClip : public VisualTool { Spline spline; /// The current spline wxToolBar *toolBar; /// The subtoolbar