qpid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acon...@apache.org
Subject qpid-proton git commit: NO-JIRA: Fix doxygen documentation warnings in C & C++
Date Wed, 06 Jan 2016 22:01:52 GMT
Repository: qpid-proton
Updated Branches:
  refs/heads/master 89440b62d -> fdc3051c9


NO-JIRA: Fix doxygen documentation warnings in C & C++


Project: http://git-wip-us.apache.org/repos/asf/qpid-proton/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-proton/commit/fdc3051c
Tree: http://git-wip-us.apache.org/repos/asf/qpid-proton/tree/fdc3051c
Diff: http://git-wip-us.apache.org/repos/asf/qpid-proton/diff/fdc3051c

Branch: refs/heads/master
Commit: fdc3051c92cea55438ff0004cd843d7ea816a14e
Parents: 89440b6
Author: Alan Conway <aconway@redhat.com>
Authored: Wed Jan 6 16:52:21 2016 -0500
Committer: Alan Conway <aconway@redhat.com>
Committed: Wed Jan 6 16:52:21 2016 -0500

----------------------------------------------------------------------
 .../bindings/cpp/include/proton/decoder.hpp     |  2 +-
 proton-c/bindings/python/CMakeLists.txt         |  2 +
 proton-c/docs/api/CMakeLists.txt                |  6 +-
 proton-c/docs/api/user.doxygen.in               | 88 +-------------------
 proton-c/include/proton/selectable.h            |  4 +-
 proton-c/include/proton/url.h                   |  9 +-
 6 files changed, 11 insertions(+), 100 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/fdc3051c/proton-c/bindings/cpp/include/proton/decoder.hpp
----------------------------------------------------------------------
diff --git a/proton-c/bindings/cpp/include/proton/decoder.hpp b/proton-c/bindings/cpp/include/proton/decoder.hpp
index 5dae3c3..9ff13ea 100644
--- a/proton-c/bindings/cpp/include/proton/decoder.hpp
+++ b/proton-c/bindings/cpp/include/proton/decoder.hpp
@@ -95,7 +95,7 @@ type or throw an exception if the types are not compatible.
 +-------------------------+-------------------------------+
 |BINARY                   |amqp_binary, std::string       |
 +-------------------------+-------------------------------+
-|DECIMAL<n>               |amqp_decimal<n>                |
+|DECIMAL32/64/128         |amqp_decimal32/64/128          |
 +-------------------------+-------------------------------+
 |TIMESTAMP                |amqp_timestamp                 |
 +-------------------------+-------------------------------+

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/fdc3051c/proton-c/bindings/python/CMakeLists.txt
----------------------------------------------------------------------
diff --git a/proton-c/bindings/python/CMakeLists.txt b/proton-c/bindings/python/CMakeLists.txt
index 05fe2d4..157a080 100644
--- a/proton-c/bindings/python/CMakeLists.txt
+++ b/proton-c/bindings/python/CMakeLists.txt
@@ -118,3 +118,5 @@ install(FILES ${PROTON_ARTIFACTS}
 install(TARGETS ${SWIG_MODULE_cproton_REAL_NAME}
         DESTINATION ${PYTHON_SITEARCH_PACKAGES}
         COMPONENT Python)
+
+set_directory_properties(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES "html;tutorial")

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/fdc3051c/proton-c/docs/api/CMakeLists.txt
----------------------------------------------------------------------
diff --git a/proton-c/docs/api/CMakeLists.txt b/proton-c/docs/api/CMakeLists.txt
index 4365aea..566ce2f 100644
--- a/proton-c/docs/api/CMakeLists.txt
+++ b/proton-c/docs/api/CMakeLists.txt
@@ -30,9 +30,5 @@ if (DOXYGEN_FOUND)
            COMPONENT documentation
            ${OPTIONAL_ARG})
 
-  # if (CPACK_GENERATOR STREQUAL "NSIS")
-  #     set (CPACK_NSIS_MENU_LINKS
-  #          "${QPID_INSTALL_HTMLDIR}/index.html" "Qpid C++ API Documentation"
-  #          "https://issues.apache.org/jira/browse/QPID" "Report Qpid Problem")
-  # endif (CPACK_GENERATOR STREQUAL "NSIS")
+  set_directory_properties(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES html)
 endif (DOXYGEN_FOUND)

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/fdc3051c/proton-c/docs/api/user.doxygen.in
----------------------------------------------------------------------
diff --git a/proton-c/docs/api/user.doxygen.in b/proton-c/docs/api/user.doxygen.in
index 82048cb..2ea0e48 100644
--- a/proton-c/docs/api/user.doxygen.in
+++ b/proton-c/docs/api/user.doxygen.in
@@ -322,22 +322,6 @@ INLINE_SIMPLE_STRUCTS  = NO
 
 TYPEDEF_HIDES_STRUCT   = NO
 
-# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
-# determine which symbols to keep in memory and which to flush to disk.
-# When the cache is full, less often used symbols will be written to disk.
-# For small to medium size projects (<1000 input files) the default value is
-# probably good enough. For larger projects a too small cache size can cause
-# doxygen to be busy swapping symbols to and from disk most of the time
-# causing a significant performance penalty.
-# If the system has enough physical memory increasing the cache will improve the
-# performance by keeping more symbols in memory. Note that the value works on
-# a logarithmic scale so increasing the size by one will roughly double the
-# memory usage. The cache size is given by this formula:
-# 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
-
-SYMBOL_CACHE_SIZE      = 0
-
 #---------------------------------------------------------------------------
 # Build related configuration options
 #---------------------------------------------------------------------------
@@ -589,7 +573,7 @@ CITE_BIB_FILES         =
 # The QUIET tag can be used to turn on/off the messages that are generated
 # by doxygen. Possible values are YES and NO. If left blank NO is used.
 
-QUIET                  = NO
+QUIET                  = YES
 
 # The WARNINGS tag can be used to turn on/off the warning messages that are
 # generated by doxygen. Possible values are YES and NO. If left blank
@@ -1355,41 +1339,6 @@ MAN_EXTENSION          = .3
 MAN_LINKS              = NO
 
 #---------------------------------------------------------------------------
-# configuration options related to the XML output
-#---------------------------------------------------------------------------
-
-# If the GENERATE_XML tag is set to YES Doxygen will
-# generate an XML file that captures the structure of
-# the code including all documentation.
-
-GENERATE_XML           = NO
-
-# The XML_OUTPUT tag is used to specify where the XML pages will be put.
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
-# put in front of it. If left blank `xml' will be used as the default path.
-
-XML_OUTPUT             = xml
-
-# The XML_SCHEMA tag can be used to specify an XML schema,
-# which can be used by a validating XML parser to check the
-# syntax of the XML files.
-
-XML_SCHEMA             =
-
-# The XML_DTD tag can be used to specify an XML DTD,
-# which can be used by a validating XML parser to check the
-# syntax of the XML files.
-
-XML_DTD                =
-
-# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
-# dump the program listings (including syntax highlighting
-# and cross-referencing information) to the XML output. Note that
-# enabling this will significantly increase the size of the XML output.
-
-XML_PROGRAMLISTING     = YES
-
-#---------------------------------------------------------------------------
 # configuration options for the AutoGen Definitions output
 #---------------------------------------------------------------------------
 
@@ -1402,41 +1351,6 @@ XML_PROGRAMLISTING     = YES
 GENERATE_AUTOGEN_DEF   = NO
 
 #---------------------------------------------------------------------------
-# configuration options related to the Perl module output
-#---------------------------------------------------------------------------
-
-# If the GENERATE_PERLMOD tag is set to YES Doxygen will
-# generate a Perl module file that captures the structure of
-# the code including all documentation. Note that this
-# feature is still experimental and incomplete at the
-# moment.
-
-GENERATE_PERLMOD       = NO
-
-# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
-# the necessary Makefile rules, Perl scripts and LaTeX code to be able
-# to generate PDF and DVI output from the Perl module output.
-
-PERLMOD_LATEX          = NO
-
-# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
-# nicely formatted so it can be parsed by a human reader.
-# This is useful
-# if you want to understand what is going on.
-# On the other hand, if this
-# tag is set to NO the size of the Perl module output will be much smaller
-# and Perl will parse it just the same.
-
-PERLMOD_PRETTY         = YES
-
-# The names of the make variables in the generated doxyrules.make file
-# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
-# This is useful so different doxyrules.make files included by the same
-# Makefile don't overwrite each other's variables.
-
-PERLMOD_MAKEVAR_PREFIX =
-
-#---------------------------------------------------------------------------
 # Configuration options related to the preprocessor
 #---------------------------------------------------------------------------
 

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/fdc3051c/proton-c/include/proton/selectable.h
----------------------------------------------------------------------
diff --git a/proton-c/include/proton/selectable.h b/proton-c/include/proton/selectable.h
index 9c8f7b1..7b0fa02 100644
--- a/proton-c/include/proton/selectable.h
+++ b/proton-c/include/proton/selectable.h
@@ -53,9 +53,7 @@ typedef pn_iterator_t pn_selectables_t;
  *
  * Every selectable is associated with exactly one file descriptor.
  * Selectables may be interested in three kinds of events, read
- * events, write events, and timer events. A selectable will express
- * its interest in these events through the ::pn_selectable_capacity(),
- * ::pn_selectable_pending(), and ::pn_selectable_deadline() calls.
+ * events, write events, and timer events. 
  *
  * When a read, write, or timer event occurs, the selectable must be
  * notified by calling ::pn_selectable_readable(),

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/fdc3051c/proton-c/include/proton/url.h
----------------------------------------------------------------------
diff --git a/proton-c/include/proton/url.h b/proton-c/include/proton/url.h
index 01e1977..80634c1 100644
--- a/proton-c/include/proton/url.h
+++ b/proton-c/include/proton/url.h
@@ -42,15 +42,16 @@ PN_EXTERN pn_url_t *pn_url(void);
 /** Parse a string URL as a pn_url_t.
  *
  * URL syntax:
- * [ <scheme> :// ] [ <user> [ : <password> ] @ ] <host> [ : <port>
] [ / <path> ]
  *
- * <scheme>, <user>, <password>, <port> cannot contain any of '@',
':', '/'
+ *     [ <scheme> :// ] [ <user> [ : <password> ] @ ] <host> [ :
<port> ] [ / <path> ]
  *
- * If the first character of <host> is '[' then it can contain any character up
+ * `scheme`, `user`, `password`, `port` cannot contain any of '@', ':', '/'
+ *
+ * If the first character of `host` is '[' then it can contain any character up
  * to ']' (this is to allow IPv6 literal syntax). Otherwise it also cannot
  * contain '@', ':', '/'
  *
- * <path> can contain any character
+ * `path` can contain any character
  *
  *@param[in] url A URL string.
  *@return The parsed pn_url_t or NULL if url is not a valid URL string.


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org


Mime
View raw message