Aegisub/aegisub/src/main.h
Amar Takhar 6ee2f98349 Note: This was done using a script! it's far from perfect but 95% of the work has been done already formatting-wise.
Document all functions, class, struct, union, enum, macro, variable, typedefs.  This isn't the actual document in itself but empty documentation using any old documentation if it was there.

This was done using exuberant ctags to get tag info, then a TCL script to parse/remove old comments and convert them into Doxygen-style.

Some notes:
 * Anything labeled 'DOCME' needs to be documented, @param and @return have been left blank as it would be annoying to delete the 'DOCME' from every one of those.
 * Some multiline comments may have been munged into single line comments
 * Leave the /// comments above global variables with a space, if they're harder to read then we'll be less likey to use them.
 * Enum comments can go after the enumeration itself '[value] /// comment'
 * include/aegisub/*.h haven't been converted yet, this will be done in a later commit
 * Some documentation blocks are in the wrong place, in the .h when it should be in the .cpp, or vice versa.

See http://devel.aegisub.org/wiki/Doxygen for some details on Doxygen and a 'style guide'.

Originally committed to SVN as r3312.
2009-07-29 22:59:22 +00:00

151 lines
3.2 KiB
C++

// Copyright (c) 2005, Rodrigo Braz Monteiro
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
// * Neither the name of the Aegisub Group nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
// Aegisub Project http://www.aegisub.org/
//
// $Id$
/// @file main.h
/// @see main.cpp
/// @ingroup main
///
#ifndef MAIN_H
/// DOCME
#define MAIN_H
///////////////////
// Include headers
#include <wx/wxprec.h>
#include <wx/app.h>
#include <wx/stackwalk.h>
#include <fstream>
#include "aegisublocale.h"
//////////////
// Prototypes
class FrameMain;
class PluginManager;
/// DOCME
namespace Automation4 { class AutoloadScriptManager; }
/// DOCME
/// @class AegisubApp
/// @brief DOCME
///
/// DOCME
class AegisubApp: public wxApp {
private:
/// DOCME
PluginManager *plugins;
void OnMouseWheel(wxMouseEvent &event);
void OnKey(wxKeyEvent &key);
public:
/// DOCME
AegisubLocale locale;
/// DOCME
FrameMain *frame;
#ifdef WITH_AUTOMATION
/// DOCME
Automation4::AutoloadScriptManager *global_scripts;
#endif
/// @brief DOCME
/// @return
///
static AegisubApp* Get() { return (AegisubApp*) wxTheApp; }
static void OpenURL(wxString url);
void RegistryAssociate();
void AssociateType(wxString type);
bool OnInit();
int OnExit();
int OnRun();
#ifdef __WXMAC__
// Apple events
virtual void MacOpenFile(const wxString &filename);
#endif
#ifndef _DEBUG
void OnUnhandledException();
void OnFatalException();
#endif
//int OnRun();
DECLARE_EVENT_TABLE()
};
DECLARE_APP(AegisubApp)
////////////////
// Stack walker
#if wxUSE_STACKWALKER == 1
/// DOCME
/// @class StackWalker
/// @brief DOCME
///
/// DOCME
class StackWalker: public wxStackWalker {
private:
/// DOCME
std::ofstream file;
/// DOCME
int formatLen;
public:
StackWalker(wxString cause);
~StackWalker();
void OnStackFrame(const wxStackFrame& frame);
};
#endif
#endif