ocarina/include/core/core.h
Anna Schumaker 0a9c6d296b Add doxygen documentation for audio.h, core.h, and version.h
I want to have all of Ocarina documented in the code, rather than in a
difficult-to-maintain DESIGN file.  Let's get going on that!

Signed-off-by: Anna Schumaker <Anna@OcarinaProject.net>
2014-09-12 16:36:46 -04:00

26 lines
515 B
C++

/**
* @file
* Copyright 2014 (c) Anna Schumaker.
*/
#ifndef OCARINA_CORE_CORE_H
#define OCARINA_CORE_CORE_H
/**
* Namespace for basic core library functions.
*/
namespace core
{
/**
* Initializes all components of the core library, including reading
* databases from disk and setting up gstreamer.
*
* @param argc Pointer to the argc initially passed to main()
* @param argv Pointer to the argv initially passed to main()
*/
void init(int *, char ***);
}
#endif /* OCARINA_CORE_CORE_H */