From 1c8df848f1d5e17ba9b2df17e8b9b47d25a6ee16 Mon Sep 17 00:00:00 2001 From: Michael Wallner Date: Wed, 30 Sep 2015 14:44:33 +0200 Subject: [PATCH] fix docs --- .gitignore | 1 + Doxyfile | 11 ++++++----- src/php_raphf_api.h | 8 ++++---- 3 files changed, 11 insertions(+), 9 deletions(-) diff --git a/.gitignore b/.gitignore index f24f704..48963a5 100644 --- a/.gitignore +++ b/.gitignore @@ -25,3 +25,4 @@ run-tests.php /.project .libs/ /php_raphf_api.h +Doxyfile.bak diff --git a/Doxyfile b/Doxyfile index 04d9e33..28dc5c3 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1,4 +1,4 @@ -# Doxyfile 1.8.9.1 +# Doxyfile 1.8.10 #--------------------------------------------------------------------------- # Project related configuration options @@ -33,7 +33,7 @@ OPTIMIZE_OUTPUT_FOR_C = YES OPTIMIZE_OUTPUT_JAVA = NO OPTIMIZE_FOR_FORTRAN = NO OPTIMIZE_OUTPUT_VHDL = NO -EXTENSION_MAPPING = +EXTENSION_MAPPING = no_extension=md MARKDOWN_SUPPORT = YES AUTOLINK_SUPPORT = YES BUILTIN_STL_SUPPORT = NO @@ -41,6 +41,7 @@ CPP_CLI_SUPPORT = NO SIP_SUPPORT = NO IDL_PROPERTY_SUPPORT = YES DISTRIBUTE_GROUP_DOC = NO +GROUP_NESTED_COMPOUNDS = NO SUBGROUPING = YES INLINE_GROUPED_CLASSES = NO INLINE_SIMPLE_STRUCTS = YES @@ -99,7 +100,7 @@ WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- -INPUT = php_raphf.h +INPUT = README.md CONTRIBUTING.md php_raphf.h src INPUT_ENCODING = UTF-8 FILE_PATTERNS = RECURSIVE = NO @@ -115,7 +116,7 @@ INPUT_FILTER = FILTER_PATTERNS = FILTER_SOURCE_FILES = NO FILTER_SOURCE_PATTERNS = -USE_MDFILE_AS_MAINPAGE = +USE_MDFILE_AS_MAINPAGE = README.md #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- @@ -144,7 +145,7 @@ HTML_HEADER = HTML_FOOTER = HTML_STYLESHEET = HTML_EXTRA_STYLESHEET = -HTML_EXTRA_FILES = +HTML_EXTRA_FILES = BUGS CONTRIBUTING.md LICENSE THANKS TODO HTML_COLORSTYLE_HUE = 220 HTML_COLORSTYLE_SAT = 100 HTML_COLORSTYLE_GAMMA = 80 diff --git a/src/php_raphf_api.h b/src/php_raphf_api.h index 4245c46..ffc9a03 100644 --- a/src/php_raphf_api.h +++ b/src/php_raphf_api.h @@ -326,7 +326,7 @@ PHP_RAPHF_API void *php_persistent_handle_accrete( * ressources. * * Example: - * ~~~~~~~~~~~~~~~{.c} + * \code{.c} * php_resource_factory_t *create_my_rf(const char *persistent_id_str, * size_t persistent_id_len TSRMLS_DC) * { @@ -347,7 +347,7 @@ PHP_RAPHF_API void *php_persistent_handle_accrete( * } * return rf; * } - * ~~~~~~~~~~~~~~~ + * \endcode */ PHP_RAPHF_API php_resource_factory_ops_t * php_persistent_handle_get_resource_factory_ops(void); @@ -404,7 +404,7 @@ PHP_RAPHF_API void php_persistent_handle_cleanup(const char *name_str, * Retrieve statistics about the current process/thread's persistent handles. * * @return a HashTable like: - * ~~~~~~~~~~~~~~~ + * \code * [ * "name" => [ * "ident" => [ @@ -413,7 +413,7 @@ PHP_RAPHF_API void php_persistent_handle_cleanup(const char *name_str, * ] * ] * ] - * ~~~~~~~~~~~~~~~ + * \endcode */ PHP_RAPHF_API HashTable *php_persistent_handle_statall(HashTable *ht TSRMLS_DC); -- 2.30.2