-
Notifications
You must be signed in to change notification settings - Fork 82
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add doxygen conf file with homepage and .gitignore
Signed-off-by: Slawomir Jankowski <[email protected]>
- Loading branch information
1 parent
720ce95
commit f0de689
Showing
3 changed files
with
335 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| html/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # Open CAS Framework environement documentation | ||
|
|
||
| # Content: | ||
| - [OCF_ENV header](ocf__env_8h.html) | ||
| - [OCF_ENV source file](ocf__env_8c.html) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,329 @@ | ||
| # Doxyfile 1.8.6 | ||
|
|
||
| #--------------------------------------------------------------------------- | ||
| # Project related configuration options | ||
| #--------------------------------------------------------------------------- | ||
| DOXYFILE_ENCODING = UTF-8 | ||
| PROJECT_NAME = "Open CAS Framework" | ||
| PROJECT_NUMBER = | ||
| PROJECT_BRIEF = "Open source framework of Cache Acceleration Software" | ||
| PROJECT_LOGO = | ||
| OUTPUT_DIRECTORY = . | ||
| CREATE_SUBDIRS = NO | ||
| ALLOW_UNICODE_NAMES = NO | ||
| OUTPUT_LANGUAGE = English | ||
| BRIEF_MEMBER_DESC = YES | ||
| REPEAT_BRIEF = YES | ||
| ABBREVIATE_BRIEF = "The $name class" \ | ||
| "The $name widget" \ | ||
| "The $name file" \ | ||
| is \ | ||
| provides \ | ||
| specifies \ | ||
| contains \ | ||
| represents \ | ||
| a \ | ||
| an \ | ||
| the | ||
| ALWAYS_DETAILED_SEC = NO | ||
| INLINE_INHERITED_MEMB = NO | ||
| FULL_PATH_NAMES = NO | ||
| STRIP_FROM_PATH = | ||
| STRIP_FROM_INC_PATH = | ||
| SHORT_NAMES = NO | ||
| JAVADOC_AUTOBRIEF = NO | ||
| QT_AUTOBRIEF = NO | ||
| MULTILINE_CPP_IS_BRIEF = NO | ||
| INHERIT_DOCS = NO | ||
| SEPARATE_MEMBER_PAGES = NO | ||
| TAB_SIZE = 8 | ||
| ALIASES = | ||
| TCL_SUBST = | ||
| OPTIMIZE_OUTPUT_FOR_C = YES | ||
| OPTIMIZE_OUTPUT_JAVA = NO | ||
| OPTIMIZE_FOR_FORTRAN = NO | ||
| OPTIMIZE_OUTPUT_VHDL = NO | ||
| EXTENSION_MAPPING = | ||
| MARKDOWN_SUPPORT = YES | ||
| AUTOLINK_SUPPORT = YES | ||
| BUILTIN_STL_SUPPORT = NO | ||
| CPP_CLI_SUPPORT = NO | ||
| SIP_SUPPORT = NO | ||
| IDL_PROPERTY_SUPPORT = YES | ||
| DISTRIBUTE_GROUP_DOC = YES | ||
| GROUP_NESTED_COMPOUNDS = YES | ||
| SUBGROUPING = YES | ||
| INLINE_GROUPED_CLASSES = NO | ||
| INLINE_SIMPLE_STRUCTS = NO | ||
| TYPEDEF_HIDES_STRUCT = NO | ||
| LOOKUP_CACHE_SIZE = 0 | ||
| #--------------------------------------------------------------------------- | ||
| # Build related configuration options | ||
| #--------------------------------------------------------------------------- | ||
| EXTRACT_ALL = YES | ||
| EXTRACT_PRIVATE = NO | ||
| EXTRACT_PACKAGE = NO | ||
| EXTRACT_STATIC = NO | ||
| EXTRACT_LOCAL_CLASSES = NO | ||
| EXTRACT_LOCAL_METHODS = NO | ||
| EXTRACT_ANON_NSPACES = NO | ||
| HIDE_UNDOC_MEMBERS = NO | ||
| HIDE_UNDOC_CLASSES = NO | ||
| HIDE_FRIEND_COMPOUNDS = NO | ||
| HIDE_IN_BODY_DOCS = NO | ||
| INTERNAL_DOCS = YES | ||
| CASE_SENSE_NAMES = NO | ||
| HIDE_SCOPE_NAMES = YES | ||
| HIDE_COMPOUND_REFERENCE= YES | ||
| SHOW_INCLUDE_FILES = NO | ||
| SHOW_GROUPED_MEMB_INC = YES | ||
| FORCE_LOCAL_INCLUDES = NO | ||
| INLINE_INFO = YES | ||
| SORT_MEMBER_DOCS = YES | ||
| SORT_BRIEF_DOCS = NO | ||
| SORT_MEMBERS_CTORS_1ST = NO | ||
| SORT_GROUP_NAMES = YES | ||
| SORT_BY_SCOPE_NAME = NO | ||
| STRICT_PROTO_MATCHING = NO | ||
| GENERATE_TODOLIST = NO | ||
| GENERATE_TESTLIST = NO | ||
| GENERATE_BUGLIST = NO | ||
| GENERATE_DEPRECATEDLIST= YES | ||
| ENABLED_SECTIONS = | ||
| MAX_INITIALIZER_LINES = 30 | ||
| SHOW_USED_FILES = YES | ||
| 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_AS_ERROR = NO | ||
| WARN_FORMAT = "$file:$line: $text" | ||
| WARN_LOGFILE = | ||
| #--------------------------------------------------------------------------- | ||
| # Configuration options related to the input files | ||
| #--------------------------------------------------------------------------- | ||
| INPUT = HOME.md ocf_env.h ocf_env.c | ||
| INPUT_ENCODING = UTF-8 | ||
| FILE_PATTERNS = *.c \ | ||
| *.h \ | ||
| *.md | ||
| RECURSIVE = YES | ||
| EXCLUDE = | ||
| EXCLUDE_SYMLINKS = NO | ||
| EXCLUDE_PATTERNS = | ||
| EXCLUDE_SYMBOLS = | ||
| EXAMPLE_PATH = | ||
| EXAMPLE_PATTERNS = * | ||
| EXAMPLE_RECURSIVE = YES | ||
| IMAGE_PATH = ./img/ | ||
| INPUT_FILTER = | ||
| FILTER_PATTERNS = | ||
| FILTER_SOURCE_FILES = NO | ||
| FILTER_SOURCE_PATTERNS = | ||
| USE_MDFILE_AS_MAINPAGE = HOME.md | ||
| #--------------------------------------------------------------------------- | ||
| # Configuration options related to source browsing | ||
| #--------------------------------------------------------------------------- | ||
| SOURCE_BROWSER = NO | ||
| INLINE_SOURCES = NO | ||
| STRIP_CODE_COMMENTS = YES | ||
| REFERENCED_BY_RELATION = YES | ||
| REFERENCES_RELATION = YES | ||
| REFERENCES_LINK_SOURCE = YES | ||
| SOURCE_TOOLTIPS = 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 | ||
| HTML_FILE_EXTENSION = .html | ||
| #HTML_HEADER = header.html | ||
| #HTML_FOOTER = footer.html | ||
| HTML_STYLESHEET = | ||
| HTML_EXTRA_STYLESHEET = | ||
| HTML_EXTRA_FILES = | ||
| HTML_COLORSTYLE_HUE = 220 | ||
| HTML_COLORSTYLE_SAT = 100 | ||
| HTML_COLORSTYLE_GAMMA = 80 | ||
| HTML_TIMESTAMP = NO | ||
| HTML_DYNAMIC_SECTIONS = NO | ||
| HTML_INDEX_NUM_ENTRIES = 100 | ||
| 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 = YES | ||
| GENERATE_TREEVIEW = YES | ||
| ENUM_VALUES_PER_LINE = 4 | ||
| TREEVIEW_WIDTH = 250 | ||
| EXT_LINKS_IN_WINDOW = NO | ||
| FORMULA_FONTSIZE = 10 | ||
| FORMULA_TRANSPARENT = YES | ||
| USE_MATHJAX = NO | ||
| MATHJAX_FORMAT = HTML-CSS | ||
| MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest | ||
| MATHJAX_EXTENSIONS = | ||
| MATHJAX_CODEFILE = | ||
| SEARCHENGINE = YES | ||
| SERVER_BASED_SEARCH = NO | ||
| EXTERNAL_SEARCH = NO | ||
| SEARCHENGINE_URL = | ||
| SEARCHDATA_FILE = searchdata.xml | ||
| EXTERNAL_SEARCH_ID = | ||
| EXTRA_SEARCH_MAPPINGS = | ||
| #--------------------------------------------------------------------------- | ||
| # 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 = | ||
| LATEX_EXTRA_STYLESHEET = | ||
| LATEX_EXTRA_FILES = | ||
| PDF_HYPERLINKS = YES | ||
| USE_PDFLATEX = YES | ||
| LATEX_BATCHMODE = NO | ||
| LATEX_HIDE_INDICES = NO | ||
| LATEX_SOURCE_CODE = NO | ||
| LATEX_BIB_STYLE = plain | ||
| LATEX_TIMESTAMP = NO | ||
| #--------------------------------------------------------------------------- | ||
| # 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 = | ||
| RTF_SOURCE_CODE = NO | ||
| #--------------------------------------------------------------------------- | ||
| # Configuration options related to the man page output | ||
| #--------------------------------------------------------------------------- | ||
| GENERATE_MAN = NO | ||
| MAN_OUTPUT = man | ||
| MAN_EXTENSION = .3 | ||
| MAN_SUBDIR = | ||
| MAN_LINKS = NO | ||
| #--------------------------------------------------------------------------- | ||
| # Configuration options related to the XML output | ||
| #--------------------------------------------------------------------------- | ||
| GENERATE_XML = NO | ||
| XML_OUTPUT = xml | ||
| XML_PROGRAMLISTING = YES | ||
| #--------------------------------------------------------------------------- | ||
| # Configuration options related to the DOCBOOK output | ||
| #--------------------------------------------------------------------------- | ||
| GENERATE_DOCBOOK = NO | ||
| DOCBOOK_OUTPUT = docbook | ||
| DOCBOOK_PROGRAMLISTING = NO | ||
| #--------------------------------------------------------------------------- | ||
| # 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 = YES | ||
| EXPAND_ONLY_PREDEF = NO | ||
| SEARCH_INCLUDES = YES | ||
| INCLUDE_PATH = | ||
| INCLUDE_FILE_PATTERNS = | ||
| PREDEFINED = | ||
| EXPAND_AS_DEFINED = | ||
| SKIP_FUNCTION_MACROS = NO | ||
| #--------------------------------------------------------------------------- | ||
| # Configuration options related to external references | ||
| #--------------------------------------------------------------------------- | ||
| TAGFILES = | ||
| GENERATE_TAGFILE = | ||
| ALLEXTERNALS = NO | ||
| EXTERNAL_GROUPS = YES | ||
| EXTERNAL_PAGES = YES | ||
| PERL_PATH = /usr/bin/perl | ||
| #--------------------------------------------------------------------------- | ||
| # Configuration options related to the dot tool | ||
| #--------------------------------------------------------------------------- | ||
| CLASS_DIAGRAMS = YES | ||
| MSCGEN_PATH = | ||
| DIA_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 | ||
| UML_LIMIT_NUM_FIELDS = 10 | ||
| 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 = | ||
| DIAFILE_DIRS = | ||
| PLANTUML_JAR_PATH = | ||
| PLANTUML_INCLUDE_PATH = | ||
| DOT_GRAPH_MAX_NODES = 50 | ||
| MAX_DOT_GRAPH_DEPTH = 0 | ||
| DOT_TRANSPARENT = NO | ||
| DOT_MULTI_TARGETS = NO | ||
| GENERATE_LEGEND = YES | ||
| DOT_CLEANUP = YES |