eclipse/paho.mqtt.cpp
1
0
Fork 0
mirror of https://github.com/eclipse/paho.mqtt.cpp.git synced 2025-05-10 03:39:07 +08:00
Code Issues Releases Wiki Activity

Fix doxygen file

Browse Source 
Remove deprecated tags and add the input documentation directory.

Signed-off-by: Guilherme Maciel Ferreira <guilherme.maciel.ferreira@gmail.com>
This commit is contained in:
Guilherme Maciel Ferreira 2017-04-11 11:57:09 -05:00
parent 0532a84646
commit fe3d463516
3 changed files with 15 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/Doxyfile.cmake
View File

@ -324,7 +324,7 @@ TYPEDEF_HIDES_STRUCT = NO
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols. # corresponding to a cache size of 2^16 = 65536 symbols.
SYMBOL_CACHE_SIZE = 0 #SYMBOL_CACHE_SIZE = 0
# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
@ -544,7 +544,7 @@ SHOW_USED_FILES = YES
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
# in the documentation. The default is NO. # in the documentation. The default is NO.
SHOW_DIRECTORIES = NO #SHOW_DIRECTORIES = NO
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
# This will remove the Files entry from the Quick Index and from the # This will remove the Files entry from the Quick Index and from the
@ -649,20 +649,7 @@ WARN_LOGFILE =
# with spaces. # with spaces.
STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@/src/mqtt STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@/src/mqtt
INPUT = @PROJECT_SOURCE_DIR@/src/mqtt/async_client.h INPUT = @PROJECT_SOURCE_DIR@/src/mqtt/
@PROJECT_SOURCE_DIR@/src/mqtt/callback.h
@PROJECT_SOURCE_DIR@/src/mqtt/client.h
@PROJECT_SOURCE_DIR@/src/mqtt/connect_options.h
@PROJECT_SOURCE_DIR@/src/mqtt/delivery_token.h
@PROJECT_SOURCE_DIR@/src/mqtt/exception.h
@PROJECT_SOURCE_DIR@/src/mqtt/iaction_listener.h
@PROJECT_SOURCE_DIR@/src/mqtt/iclient_persistence.h
@PROJECT_SOURCE_DIR@/src/mqtt/ipersistable.h
@PROJECT_SOURCE_DIR@/src/mqtt/message.h
@PROJECT_SOURCE_DIR@/src/mqtt/token.h
@PROJECT_SOURCE_DIR@/src/mqtt/topic.h
@PROJECT_SOURCE_DIR@/src/mqtt/will_options.h
@PROJECT_SOURCE_DIR@/src/mqtt/ssl_options.h
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@ -952,7 +939,7 @@ HTML_TIMESTAMP = YES
# files or namespaces will be aligned in HTML using tables. If set to # files or namespaces will be aligned in HTML using tables. If set to
# NO a bullet list will be used. # NO a bullet list will be used.
HTML_ALIGN_MEMBERS = YES #HTML_ALIGN_MEMBERS = YES
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the # documentation will contain sections that can be hidden and shown after the
@ -1143,7 +1130,7 @@ ENUM_VALUES_PER_LINE = 4
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
# and Class Hierarchy pages using a tree view instead of an ordered list. # and Class Hierarchy pages using a tree view instead of an ordered list.
USE_INLINE_TREES = NO #USE_INLINE_TREES = NO
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
# used to set the initial width (in pixels) of the frame in which the tree # used to set the initial width (in pixels) of the frame in which the tree
@ -1406,13 +1393,13 @@ XML_OUTPUT = xml
# which can be used by a validating XML parser to check the # which can be used by a validating XML parser to check the
# syntax of the XML files. # syntax of the XML files.
XML_SCHEMA = #XML_SCHEMA =
# The XML_DTD tag can be used to specify an XML DTD, # The XML_DTD tag can be used to specify an XML DTD,
# which can be used by a validating XML parser to check the # which can be used by a validating XML parser to check the
# syntax of the XML files. # syntax of the XML files.
XML_DTD = #XML_DTD =
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
# dump the program listings (including syntax highlighting # dump the program listings (including syntax highlighting

27
doc/Doxyfile.in
View File

@ -324,7 +324,7 @@ TYPEDEF_HIDES_STRUCT = NO
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols. # corresponding to a cache size of 2^16 = 65536 symbols.
SYMBOL_CACHE_SIZE = 0 #SYMBOL_CACHE_SIZE = 0
# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
@ -544,7 +544,7 @@ SHOW_USED_FILES = YES
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
# in the documentation. The default is NO. # in the documentation. The default is NO.
SHOW_DIRECTORIES = NO #SHOW_DIRECTORIES = NO
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
# This will remove the Files entry from the Quick Index and from the # This will remove the Files entry from the Quick Index and from the
@ -649,20 +649,7 @@ WARN_LOGFILE =
# with spaces. # with spaces.
STRIP_FROM_PATH = @top_srcdir@/src/mqtt STRIP_FROM_PATH = @top_srcdir@/src/mqtt
INPUT = @top_srcdir@/src/mqtt/async_client.h INPUT = @top_srcdir@/src/mqtt/
@top_srcdir@/src/mqtt/callback.h
@top_srcdir@/src/mqtt/client.h
@top_srcdir@/src/mqtt/connect_options.h
@top_srcdir@/src/mqtt/delivery_token.h
@top_srcdir@/src/mqtt/exception.h
@top_srcdir@/src/mqtt/iaction_listener.h
@top_srcdir@/src/mqtt/iclient_persistence.h
@top_srcdir@/src/mqtt/ipersistable.h
@top_srcdir@/src/mqtt/message.h
@top_srcdir@/src/mqtt/token.h
@top_srcdir@/src/mqtt/topic.h
@top_srcdir@/src/mqtt/will_options.h
@top_srcdir@/src/mqtt/ssl_options.h
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@ -952,7 +939,7 @@ HTML_TIMESTAMP = YES
# files or namespaces will be aligned in HTML using tables. If set to # files or namespaces will be aligned in HTML using tables. If set to
# NO a bullet list will be used. # NO a bullet list will be used.
HTML_ALIGN_MEMBERS = YES #HTML_ALIGN_MEMBERS = YES
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the # documentation will contain sections that can be hidden and shown after the
@ -1143,7 +1130,7 @@ ENUM_VALUES_PER_LINE = 4
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
# and Class Hierarchy pages using a tree view instead of an ordered list. # and Class Hierarchy pages using a tree view instead of an ordered list.
USE_INLINE_TREES = NO #USE_INLINE_TREES = NO
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
# used to set the initial width (in pixels) of the frame in which the tree # used to set the initial width (in pixels) of the frame in which the tree
@ -1406,13 +1393,13 @@ XML_OUTPUT = xml
# which can be used by a validating XML parser to check the # which can be used by a validating XML parser to check the
# syntax of the XML files. # syntax of the XML files.
XML_SCHEMA = #XML_SCHEMA =
# The XML_DTD tag can be used to specify an XML DTD, # The XML_DTD tag can be used to specify an XML DTD,
# which can be used by a validating XML parser to check the # which can be used by a validating XML parser to check the
# syntax of the XML files. # syntax of the XML files.
XML_DTD = #XML_DTD =
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
# dump the program listings (including syntax highlighting # dump the program listings (including syntax highlighting

1
src/mqtt/disconnect_options.h
View File

@ -36,6 +36,7 @@ public:
disconnect_options(); disconnect_options();
/** /**
* Creates disconnect options tied to the specific delivery token. * Creates disconnect options tied to the specific delivery token.
* @param timeout The timeout (in milliseconds).
* @param tok A token to be used as the context. * @param tok A token to be used as the context.
*/ */
disconnect_options(int timeout, token* tok); disconnect_options(int timeout, token* tok);