Add doxygen file

.gitignore

@@ -71,12 +71,9 @@ source/tests/Thread
 source/tests/Utils
 
 # Docs
-doc/carla-backend/
-doc/carla-bridge/
-doc/carla-engine/
-doc/carla-native/
-doc/carla-plugin/
-doc/distrho/
+doc/CarlaBackend/
+doc/CarlaBridge/
+doc/DISTRHO/
 
 # CX-Freeze builds
 src/dist/

source/backend/CarlaBackend.doxygen

@@ -0,0 +1,290 @@
+# Doxyfile 1.7.6.1
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+DOXYFILE_ENCODING      = UTF-8
+PROJECT_NAME           = "Carla Backend"
+PROJECT_NUMBER         =
+PROJECT_BRIEF          =
+PROJECT_LOGO           =
+OUTPUT_DIRECTORY       = ../../doc/CarlaBackend
+CREATE_SUBDIRS         = NO
+OUTPUT_LANGUAGE        = English
+BRIEF_MEMBER_DESC      = YES
+REPEAT_BRIEF           = YES
+ABBREVIATE_BRIEF       =
+ALWAYS_DETAILED_SEC    = NO
+INLINE_INHERITED_MEMB  = NO
+FULL_PATH_NAMES        = YES
+STRIP_FROM_PATH        =
+STRIP_FROM_INC_PATH    =
+SHORT_NAMES            = NO
+JAVADOC_AUTOBRIEF      = NO
+QT_AUTOBRIEF           = NO
+MULTILINE_CPP_IS_BRIEF = NO
+INHERIT_DOCS           = YES
+SEPARATE_MEMBER_PAGES  = NO
+TAB_SIZE               = 4
+ALIASES                =
+TCL_SUBST              =
+OPTIMIZE_OUTPUT_FOR_C  = NO
+OPTIMIZE_OUTPUT_JAVA   = NO
+OPTIMIZE_FOR_FORTRAN   = NO
+OPTIMIZE_OUTPUT_VHDL   = NO
+EXTENSION_MAPPING      =
+BUILTIN_STL_SUPPORT    = NO
+CPP_CLI_SUPPORT        = NO
+SIP_SUPPORT            = NO
+IDL_PROPERTY_SUPPORT   = YES
+DISTRIBUTE_GROUP_DOC   = NO
+SUBGROUPING            = YES
+INLINE_GROUPED_CLASSES = NO
+INLINE_SIMPLE_STRUCTS  = NO
+TYPEDEF_HIDES_STRUCT   = NO
+SYMBOL_CACHE_SIZE      = 0
+LOOKUP_CACHE_SIZE      = 0
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+EXTRACT_ALL            = YES
+EXTRACT_PRIVATE        = NO
+EXTRACT_STATIC         = YES
+EXTRACT_LOCAL_CLASSES  = YES
+EXTRACT_LOCAL_METHODS  = YES
+EXTRACT_ANON_NSPACES   = NO
+HIDE_UNDOC_MEMBERS     = NO
+HIDE_UNDOC_CLASSES     = NO
+HIDE_FRIEND_COMPOUNDS  = NO
+HIDE_IN_BODY_DOCS      = NO
+INTERNAL_DOCS          = NO
+CASE_SENSE_NAMES       = YES
+HIDE_SCOPE_NAMES       = NO
+SHOW_INCLUDE_FILES     = YES
+FORCE_LOCAL_INCLUDES   = NO
+INLINE_INFO            = YES
+SORT_MEMBER_DOCS       = NO
+SORT_BRIEF_DOCS        = NO
+SORT_MEMBERS_CTORS_1ST = NO
+SORT_GROUP_NAMES       = NO
+SORT_BY_SCOPE_NAME     = NO
+STRICT_PROTO_MATCHING  = NO
+GENERATE_TODOLIST      = YES
+GENERATE_TESTLIST      = YES
+GENERATE_BUGLIST       = YES
+GENERATE_DEPRECATEDLIST= YES
+ENABLED_SECTIONS       =
+MAX_INITIALIZER_LINES  = 30
+SHOW_USED_FILES        = YES
+SHOW_DIRECTORIES       = NO
+SHOW_FILES             = YES
+SHOW_NAMESPACES        = YES
+FILE_VERSION_FILTER    =
+LAYOUT_FILE            =
+CITE_BIB_FILES         =
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET                  = NO
+WARNINGS               = YES
+WARN_IF_UNDOCUMENTED   = YES
+WARN_IF_DOC_ERROR      = YES
+WARN_NO_PARAMDOC       = NO
+WARN_FORMAT            = "$file:$line: $text"
+WARN_LOGFILE           =
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT                  =
+INPUT_ENCODING         = UTF-8
+FILE_PATTERNS          =
+RECURSIVE              = NO
+EXCLUDE                =
+EXCLUDE_SYMLINKS       = NO
+EXCLUDE_PATTERNS       =
+EXCLUDE_SYMBOLS        =
+EXAMPLE_PATH           =
+EXAMPLE_PATTERNS       =
+EXAMPLE_RECURSIVE      = NO
+IMAGE_PATH             =
+INPUT_FILTER           =
+FILTER_PATTERNS        =
+FILTER_SOURCE_FILES    = NO
+FILTER_SOURCE_PATTERNS =
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+SOURCE_BROWSER         = NO
+INLINE_SOURCES         = NO
+STRIP_CODE_COMMENTS    = YES
+REFERENCED_BY_RELATION = NO
+REFERENCES_RELATION    = NO
+REFERENCES_LINK_SOURCE = YES
+USE_HTAGS              = NO
+VERBATIM_HEADERS       = YES
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+ALPHABETICAL_INDEX     = YES
+COLS_IN_ALPHA_INDEX    = 5
+IGNORE_PREFIX          =
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+GENERATE_HTML          = YES
+HTML_OUTPUT            = .
+HTML_FILE_EXTENSION    = .html
+HTML_HEADER            =
+HTML_FOOTER            =
+HTML_STYLESHEET        =
+HTML_EXTRA_FILES       =
+HTML_COLORSTYLE_HUE    = 220
+HTML_COLORSTYLE_SAT    = 100
+HTML_COLORSTYLE_GAMMA  = 80
+HTML_TIMESTAMP         = YES
+HTML_ALIGN_MEMBERS     = YES
+HTML_DYNAMIC_SECTIONS  = NO
+GENERATE_DOCSET        = NO
+DOCSET_FEEDNAME        = "Doxygen generated docs"
+DOCSET_BUNDLE_ID       = org.doxygen.Project
+DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
+DOCSET_PUBLISHER_NAME  = Publisher
+GENERATE_HTMLHELP      = NO
+CHM_FILE               =
+HHC_LOCATION           =
+GENERATE_CHI           = NO
+CHM_INDEX_ENCODING     =
+BINARY_TOC             = NO
+TOC_EXPAND             = NO
+GENERATE_QHP           = NO
+QCH_FILE               =
+QHP_NAMESPACE          = org.doxygen.Project
+QHP_VIRTUAL_FOLDER     = doc
+QHP_CUST_FILTER_NAME   =
+QHP_CUST_FILTER_ATTRS  =
+QHP_SECT_FILTER_ATTRS  =
+QHG_LOCATION           =
+GENERATE_ECLIPSEHELP   = NO
+ECLIPSE_DOC_ID         = org.doxygen.Project
+DISABLE_INDEX          = NO
+GENERATE_TREEVIEW      = NO
+ENUM_VALUES_PER_LINE   = 4
+USE_INLINE_TREES       = NO
+TREEVIEW_WIDTH         = 250
+EXT_LINKS_IN_WINDOW    = NO
+FORMULA_FONTSIZE       = 10
+FORMULA_TRANSPARENT    = YES
+USE_MATHJAX            = NO
+MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
+MATHJAX_EXTENSIONS     =
+SEARCHENGINE           = YES
+SERVER_BASED_SEARCH    = NO
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+GENERATE_LATEX         = NO
+LATEX_OUTPUT           = latex
+LATEX_CMD_NAME         = latex
+MAKEINDEX_CMD_NAME     = makeindex
+COMPACT_LATEX          = NO
+PAPER_TYPE             = a4
+EXTRA_PACKAGES         =
+LATEX_HEADER           =
+LATEX_FOOTER           =
+PDF_HYPERLINKS         = YES
+USE_PDFLATEX           = YES
+LATEX_BATCHMODE        = NO
+LATEX_HIDE_INDICES     = NO
+LATEX_SOURCE_CODE      = NO
+LATEX_BIB_STYLE        = plain
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+GENERATE_RTF           = NO
+RTF_OUTPUT             = rtf
+COMPACT_RTF            = NO
+RTF_HYPERLINKS         = NO
+RTF_STYLESHEET_FILE    =
+RTF_EXTENSIONS_FILE    =
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+GENERATE_MAN           = NO
+MAN_OUTPUT             = man
+MAN_EXTENSION          = .3
+MAN_LINKS              = NO
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+GENERATE_XML           = NO
+XML_OUTPUT             = xml
+XML_SCHEMA             =
+XML_DTD                =
+XML_PROGRAMLISTING     = YES
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+GENERATE_AUTOGEN_DEF   = NO
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+GENERATE_PERLMOD       = NO
+PERLMOD_LATEX          = NO
+PERLMOD_PRETTY         = YES
+PERLMOD_MAKEVAR_PREFIX =
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+ENABLE_PREPROCESSING   = YES
+MACRO_EXPANSION        = NO
+EXPAND_ONLY_PREDEF     = NO
+SEARCH_INCLUDES        = YES
+INCLUDE_PATH           =
+INCLUDE_FILE_PATTERNS  =
+PREDEFINED             = DOXYGEN \
+                         WANT_LADSPA WANT_DSSI WANT_LV2 WANT_VST WANT_FLUIDSYNTH WANT_LINUXSAMPLER \
+                         WANT_JACK WANT_JACK_LATENCY WANT_JACK_PORT_RENAME WANT_RTAUDIO \
+                         WANT_AUDIOFILE WANT_MIDIFILE WANT_OPENGL WANT_ZYNADDSUBFX WANT_ZYNADDSUBFX_UI
+EXPAND_AS_DEFINED      =
+SKIP_FUNCTION_MACROS   = YES
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+TAGFILES               =
+GENERATE_TAGFILE       =
+ALLEXTERNALS           = NO
+EXTERNAL_GROUPS        = YES
+PERL_PATH              = /usr/bin/perl
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+CLASS_DIAGRAMS         = YES
+MSCGEN_PATH            =
+HIDE_UNDOC_RELATIONS   = YES
+HAVE_DOT               = NO
+DOT_NUM_THREADS        = 0
+DOT_FONTNAME           = Helvetica
+DOT_FONTSIZE           = 10
+DOT_FONTPATH           =
+CLASS_GRAPH            = YES
+COLLABORATION_GRAPH    = YES
+GROUP_GRAPHS           = YES
+UML_LOOK               = NO
+TEMPLATE_RELATIONS     = NO
+INCLUDE_GRAPH          = YES
+INCLUDED_BY_GRAPH      = YES
+CALL_GRAPH             = NO
+CALLER_GRAPH           = NO
+GRAPHICAL_HIERARCHY    = YES
+DIRECTORY_GRAPH        = YES
+DOT_IMAGE_FORMAT       = png
+INTERACTIVE_SVG        = NO
+DOT_PATH               =
+DOTFILE_DIRS           =
+MSCFILE_DIRS           =
+DOT_GRAPH_MAX_NODES    = 50
+MAX_DOT_GRAPH_DEPTH    = 0
+DOT_TRANSPARENT        = NO
+DOT_MULTI_TARGETS      = YES
+GENERATE_LEGEND        = YES
+DOT_CLEANUP            = YES

source/backend/CarlaBackend.hpp

@@ -33,7 +33,8 @@ CARLA_BACKEND_START_NAMESPACE
 /*!
  * @defgroup CarlaBackendAPI Carla Backend API
  *
- * The Carla Backend API
+ * The Carla Backend API.\n
+ * This is the base definitions for everything the Carla code.
  *
  * @{
  */
@@ -116,9 +117,9 @@ const unsigned int PATCHBAY_PORT_IS_MIDI   = 0x8; //!< Patchbay port is of MIDI
  * Types are valid URIs.\n
  * Any non-string, non-simple type (not integral) is saved in a base64 encoded format.
  */
-const char* const CUSTOM_DATA_INVALID = nullptr;                                  //!< Null/Invalid data.
-const char* const CUSTOM_DATA_CHUNK   = "http://kxstudio.sf.net/ns/carla/chunk";  //!< Carla Chunk
-const char* const CUSTOM_DATA_STRING  = "http://kxstudio.sf.net/ns/carla/string"; //!< Carla String
+const char* const CUSTOM_DATA_INVALID = nullptr;                                  //!< Null or Invalid data.
+const char* const CUSTOM_DATA_CHUNK   = "http://kxstudio.sf.net/ns/carla/chunk";  //!< Carla Chunk URI
+const char* const CUSTOM_DATA_STRING  = "http://kxstudio.sf.net/ns/carla/string"; //!< Carla String URI
 /**@}*/
 
 #if 0

source/backend/CarlaEngine.hpp

@@ -27,9 +27,13 @@ struct CarlaOscData;
 
 CARLA_BACKEND_START_NAMESPACE
 
-#if 0
-} // Fix editor indentation
-#endif
+/*!
+ * @defgroup CarlaEngineAPI Carla Engine API
+ *
+ * The Carla Engine API.
+ *
+ * @{
+ */
 
 // -----------------------------------------------------------------------
 
@@ -59,7 +63,7 @@ enum EngineType {
     kEngineTypePlugin = 3,
 
     /*!
-    * TODO.
+    * Bridge engine type, used in BridgePlugin class.
     */
     kEngineTypeBridge = 4
 };

source/backend/CarlaNative.hpp

@@ -39,6 +39,7 @@ public:
     {
     }
 
+protected:
     // -------------------------------------------------------------------
     // Host calls
 
@@ -137,7 +138,6 @@ public:
         return nullptr;
     }
 
-protected:
     // -------------------------------------------------------------------
     // Plugin parameter calls
 

source/backend/CarlaPlugin.hpp

@@ -30,9 +30,13 @@ typedef struct _PluginDescriptor PluginDescriptor;
 
 CARLA_BACKEND_START_NAMESPACE
 
-#if 0
-} // Fix editor indentation
-#endif
+/*!
+ * @defgroup CarlaPluginAPI Carla Plugin API
+ *
+ * The Carla Plugin API.
+ *
+ * @{
+ */
 
 /*!
  * TODO.

source/backend/CarlaStandalone.hpp

@@ -21,9 +21,9 @@
 #include "CarlaBackend.hpp"
 
 /*!
- * @defgroup CarlaBackendStandalone Carla Backend Standalone
+ * @defgroup CarlaStandaloneAPI Carla Standalone API
  *
- * The Carla Backend Standalone API
+ * The Carla  Standalone API
  *
  * @{
  */

source/backend/Makefile

@@ -24,3 +24,8 @@ clean:
 
 debug:
 	$(MAKE) DEBUG=true
+
+# --------------------------------------------------------------
+
+doc: CarlaBackend.doxygen
+	doxygen $^

source/backend/plugin/CarlaPlugin.cpp

@@ -425,7 +425,7 @@ const SaveState& CarlaPlugin::getSaveState()
     saveState.reset();
     prepareForSave();
 
-    char strBuf[STR_MAX];
+    char strBuf[STR_MAX+1];
 
     // ----------------------------
     // Basic info
@@ -578,7 +578,7 @@ const SaveState& CarlaPlugin::getSaveState()
 
 void CarlaPlugin::loadSaveState(const SaveState& saveState)
 {
-    char strBuf[STR_MAX];
+    char strBuf[STR_MAX+1];
 
     // ---------------------------------------------------------------------
     // Part 1 - set custom data (except binary/chunks)
@@ -1426,10 +1426,10 @@ void CarlaPlugin::registerToOscClient()
 
     // Base data
     {
-        char bufName[STR_MAX]  = { 0 };
-        char bufLabel[STR_MAX] = { 0 };
-        char bufMaker[STR_MAX] = { 0 };
-        char bufCopyright[STR_MAX] = { 0 };
+        char bufName[STR_MAX+1]  = { 0 };
+        char bufLabel[STR_MAX+1] = { 0 };
+        char bufMaker[STR_MAX+1] = { 0 };
+        char bufCopyright[STR_MAX+1] = { 0 };
         getRealName(bufName);
         getLabel(bufLabel);
         getMaker(bufMaker);
@@ -1459,7 +1459,7 @@ void CarlaPlugin::registerToOscClient()
     // Plugin Parameters
     if (kData->param.count > 0 && kData->param.count < kData->engine->getOptions().maxParameters)
     {
-        char bufName[STR_MAX], bufUnit[STR_MAX];
+        char bufName[STR_MAX+1], bufUnit[STR_MAX+1];
 
         for (uint32_t i=0; i < kData->param.count; i++)
         {

source/backend/plugin/CarlaPlugin.pro

@@ -73,8 +73,7 @@ HEADERS += \
     ../../utils/CarlaOscUtils.hpp \
     ../../utils/CarlaStateUtils.hpp \
     ../../utils/CarlaMutex.hpp \
-    ../../utils/CarlaString.hpp \
-    ../../utils/CarlaThread.hpp
+    ../../utils/CarlaString.hpp
 
 INCLUDEPATH = . .. \
     ../../includes \

source/backend/plugin/VstPlugin.cpp

@@ -812,7 +812,7 @@ public:
         // 1. IL Harmless - disable threaded processing
         if (fEffect->uniqueID == 1229484653)
         {
-            char strBuf[STR_MAX] = { 0 };
+            char strBuf[STR_MAX+1] = { 0 };
             getLabel(strBuf);
 
             if (std::strcmp(strBuf, "IL Harmless") == 0)
@@ -850,7 +850,7 @@ public:
             // Update names
             for (i=0; i < count; i++)
             {
-                char strBuf[STR_MAX] = { 0 };
+                char strBuf[STR_MAX+1] = { 0 };
                 if (dispatcher(effGetProgramNameIndexed, i, 0, strBuf, 0.0f) != 1)
                 {
                     // program will be [re-]changed later
@@ -1975,7 +1975,7 @@ protected:
 
                 if (current >= 0 && current < static_cast<int32_t>(kData->prog.count))
                 {
-                    char strBuf[STR_MAX]  = { 0 };
+                    char strBuf[STR_MAX+1]  = { 0 };
                     dispatcher(effGetProgramName, 0, 0, strBuf, 0.0f);
 
                     if (kData->prog.names[current] != nullptr)
@@ -2127,7 +2127,7 @@ public:
         }
         else
         {
-            char strBuf[STR_MAX] = { 0 };
+            char strBuf[STR_MAX+1] = { 0 };
             dispatcher(effGetEffectName, 0, 0, strBuf, 0.0f);
 
             if (strBuf[0] != 0)