diff --git a/docs/rapidmix.doxyfile b/docs/rapidmix.doxyfile index 66eb95d6215873b50237aa149b51e5d4eceb03af..536883129adf4828d5257cd50460d363a92b99af 100644 --- a/docs/rapidmix.doxyfile +++ b/docs/rapidmix.doxyfile @@ -32,33 +32,33 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "Rapid-API-Internal" +PROJECT_NAME = "Rapid-Mix API" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = "v0.2" +PROJECT_NUMBER = "v2.0.0" # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = "A simple library for interactive machine learning" +PROJECT_BRIEF = "A simple library for machine learning & signal processing" # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = "rapidmix_small.png" +PROJECT_LOGO = "docs/rapidmix_small.png" # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = "docs_doxygen" +OUTPUT_DIRECTORY = "docs/doxygen" # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and @@ -792,7 +792,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ./rapidmix_api +INPUT = ./src # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses diff --git a/docs/rapidmix_small.png b/docs/rapidmix_small.png new file mode 100644 index 0000000000000000000000000000000000000000..9f3c0d9c99873b6c1d1f7be758738a18a9cc095d Binary files /dev/null and b/docs/rapidmix_small.png differ diff --git a/src/rapidmix.h b/src/rapidmix.h new file mode 100644 index 0000000000000000000000000000000000000000..3138488f3f8b09d9c1a56bae019aa498e5d314ff --- /dev/null +++ b/src/rapidmix.h @@ -0,0 +1,28 @@ +///////////////////////////////////////////////////////////////////////////// +// ______ _ _ ___ ____ ___ ______ _____ // +// | ___ \ (_) | | | \/ (_) / _ \ | ___ \_ _| // +// | |_/ /__ _ _ __ _ __| |______| . . |___ __ / /_\ \| |_/ / | | // +// | // _` | '_ \| |/ _` |______| |\/| | \ \/ / | _ || __/ | | // +// | |\ \ (_| | |_) | | (_| | | | | | |> < | | | || | _| |_ // +// \_| \_\__,_| .__/|_|\__,_| \_| |_/_/_/\_\ \_| |_/\_| \___/ // +// | | // +// |_| // +///////////////////////////////////////////////////////////////////////////// + +#ifndef rapidmix_h +#define rapidmix_h + +#define RAPIDMIX_VERSION_MAJOR 2 +#define RAPIDMIX_VERSION_MINOR 0 +#define RAPIDMIX_VERSION_PATCH 0 +#define RAPIDMIX_VERSION "2.0.0" +#define RAPIDMIX_REVISION "31-May-2017" + +#define RAPIDMIX_BEGIN_NAMESPACE namespace rapidmix { +#define RAPIDMIX_END_NAMESPACE } + +#include "machineLearning.h" +#include "trainingData.h" +#include "signalProcessing.h" + +#endif