AutoDoc.h File Reference

#include <vector>
#include <string>
#include <stdio.h>

Go to the source code of this file.

Classes
class	warptwin::AutoDoc
	Class to document from code. More...

Namespaces
namespace	warptwin
	Class to propagate CR3BP dynamics in characteristic units.

Macros
#define	AUTODOC_SUCCESS   0
#define	AUTODOC_FAILURE   1

Variables
const std::string	warptwin::TITLE = "= "
const std::string	warptwin::AUTHOR_EMAIL_START = " <"
const std::string	warptwin::AUTHOR_EMAIL_END = "> "
const std::string	warptwin::HEADER_ONE = "== "
const std::string	warptwin::HEADER_TWO = "=== "
const std::string	warptwin::CODE_LITERAL = "```"
const std::string	warptwin::TABLE_HEADER_START = "[\%header,cols="
const std::string	warptwin::TABLE_HEADER_END = "*]\n"
const std::string	warptwin::TABLE_MARKER = "|===\n"
const std::string	warptwin::TABLE_LINE_START = "|"
const std::string	warptwin::IMAGE_START = "image::"
const std::string	warptwin::ALIAS_START = "["
const std::string	warptwin::ALIAS_END = "]"
const std::string	warptwin::LINK_START = "link:++"
const std::string	warptwin::LINK_END = "++"
const std::string	warptwin::DOC_REF_START = "xref:"

Macro Definition Documentation

AUTODOC_FAILURE

#define AUTODOC_FAILURE   1

AUTODOC_SUCCESS

#define AUTODOC_SUCCESS   0