Merge pull request #120 from PJK/pk/release

Doc fixups
PJK · Mar 15, 2020 · c39f62a · c39f62a
2 parents bba1ec1 + df2a528
commit c39f62a
Show file tree

Hide file tree

Showing 8 changed files with 60 additions and 23 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,14 +1,16 @@
+Next
+---------------------
+
 0.6.0 (2020-03-15)
--------
+---------------------
 - Correctly set .so version [[Fixes #52]](https://github.com/PJK/libcbor/issues/52). 
     - **Warning**: All previous releases will be identified as 0.0 by the linker.
 - Fix & prevent heap overflow error in example code [[#74]](https://github.com/PJK/libcbor/pull/74) [[#76]](https://github.com/PJK/libcbor/pull/76) (by @nevun)
 - Correctly set OSX dynamic library version [[Fixes #75]](https://github.com/PJK/libcbor/issues/75)
 - [Fix misplaced 0xFF bytes in maps possibly causing memory corruption](https://github.com/PJK/libcbor/pull/82)
 - BREAKING: Fix handling & cleanup of failed memory allocation in constructor
   and builder helper functions [[Fixes #84]](https://github.com/PJK/libcbor/issues/84)
-  - All cbor_new_ and cbor_build_ functions will now explicitly return NULL
-    when memory allocation fails
+  - All cbor_new_* and cbor_build_* functions will now explicitly return NULL when memory allocation fails
   - It is up to the client to handle such cases
 - Globally enforced code style [[Fixes #83]](https://github.com/PJK/libcbor/issues/83)
 - Fix issue possible memory corruption bug on repeated 

diff --git a/Doxyfile b/Doxyfile
@@ -1989,15 +1989,15 @@ ENABLE_PREPROCESSING   = YES
 # The default value is: NO.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-MACRO_EXPANSION        = NO
+MACRO_EXPANSION        = YES
 
 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
 # the macro expansion is limited to the macros specified with the PREDEFINED and
 # EXPAND_AS_DEFINED tags.
 # The default value is: NO.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-EXPAND_ONLY_PREDEF     = NO
+EXPAND_ONLY_PREDEF     = YES
 
 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
 # INCLUDE_PATH will be searched if a #include is found.
@@ -2029,7 +2029,7 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             = CBOR_CUSTOM_ALLOC
+PREDEFINED             = CBOR_CUSTOM_ALLOC CBOR_RESTRICT_POINTER=
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The
@@ -2038,7 +2038,7 @@ PREDEFINED             = CBOR_CUSTOM_ALLOC
 # definition found in the source code.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-EXPAND_AS_DEFINED      =
+EXPAND_AS_DEFINED      = CBOR_RESTRICT_POINTER
 
 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
 # remove all references to function-like macros that are alone on a line, have

diff --git a/doc/source/api/type_7.rst b/doc/source/api/type_7.rst
@@ -28,7 +28,6 @@ Reading data
 .. doxygenfunction:: cbor_float_get_float8
 .. doxygenfunction:: cbor_float_get_float
 .. doxygenfunction:: cbor_ctrl_value
-.. doxygenfunction::
 
 Creating new items
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -40,6 +40,7 @@
 
 # on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+print(subprocess.check_output('cd ../..; mkdir doc/build; doxygen', shell=True))
 
 if on_rtd:
     print(subprocess.check_output('cd ../..; mkdir doc/build; doxygen', shell=True))

diff --git a/doc/source/development.rst b/doc/source/development.rst
@@ -23,7 +23,7 @@ Goals
 ~~~~~~~~~~~~~~~~~~~~~~
 
 RFC-conformance and full feature support
-^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Anything the standard allows, libcbor can do.
 
@@ -62,7 +62,7 @@ was the original niche of libcbor. Users who rely on libcbor expect future
 updates to work on their target platform.
 
 Stable and predictable API
-^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 libcbor will not break without a warning.
 

diff --git a/doc/source/getting_started.rst b/doc/source/getting_started.rst
@@ -19,7 +19,8 @@ Prerequisites:
  - C99 compiler
  - CMake_ 2.8 or newer (might also be called ``cmakesetup``, ``cmake-gui`` or ``ccmake`` depending on the installed version and system)
  - C build system CMake can target (make, Apple Xcode, MinGW, ...)
- .. _CMake: http://cmake.org/
+
+.. _CMake: http://cmake.org/
 
 .. note:: As of May 2015, not even the 2015 release candidate of Visual Studio supports C99. While CMake will be happy to generate a VS solution that you can play with, libcbor currently cannot be compiled using the MSVC toolchain. `ICC <https://software.intel.com/en-us/c-compilers>`_, GCC under `Cygwin <https://www.cygwin.com/>`_, and `MinGW's <http://www.mingw.org/>`_ GCC will all work. The MinGW build process is described below.
 

diff --git a/doc/source/internal.rst b/doc/source/internal.rst
@@ -110,16 +110,16 @@ Generally speaking, data items consist of three parts:
 
     Union type of the following members, based on the item type:
 
-    .. member:: struct _cbor_int_metadata int_metadata;
+    .. member:: struct _cbor_int_metadata int_metadata
 
         Used both by both :doc:`api/type_0_1`
 
-    .. member:: struct _cbor_bytestring_metadata bytestring_metadata;
-    .. member:: struct _cbor_string_metadata string_metadata;
-    .. member:: struct _cbor_array_metadata array_metadata;
-    .. member:: struct _cbor_map_metadata map_metadata;
-    .. member:: struct _cbor_tag_metadata tag_metadata;
-    .. member:: struct _cbor_float_ctrl_metadata float_ctrl_metadata;
+    .. member:: struct _cbor_bytestring_metadata bytestring_metadata
+    .. member:: struct _cbor_string_metadata string_metadata
+    .. member:: struct _cbor_array_metadata array_metadata
+    .. member:: struct _cbor_map_metadata map_metadata
+    .. member:: struct _cbor_tag_metadata tag_metadata
+    .. member:: struct _cbor_float_ctrl_metadata float_ctrl_metadata
 
 Decoding
 ---------

diff --git a/doc/source/requirements.txt b/doc/source/requirements.txt
@@ -1,5 +1,39 @@
--e git+https://github.com/michaeljones/breathe@master#egg=breathe
-Sphinx==1.6.3
-sphinx-autobuild==0.6.0
-sphinx-rtd-theme==0.1.9
-sphinxcontrib-websupport==1.0.1
+alabaster==0.7.12
+argh==0.26.2
+Babel==2.8.0
+breathe==4.14.1
+certifi==2019.11.28
+chardet==3.0.4
+Click==7.0
+docutils==0.16
+Flask==1.1.1
+idna==2.9
+imagesize==1.2.0
+itsdangerous==1.1.0
+Jinja2==2.10.1
+livereload==2.6.1
+MarkupSafe==1.1.1
+packaging==20.3
+pathtools==0.1.2
+port-for==0.3.1
+Pygments==2.6.1
+pyparsing==2.4.6
+pytz==2019.3
+PyYAML==5.3
+requests==2.23.0
+six==1.14.0
+snowballstemmer==2.0.0
+sortedcontainers==2.1.0
+Sphinx==2.4.4
+sphinx-autobuild==0.7.1
+sphinx-rtd-theme==0.4.3
+sphinxcontrib-applehelp==1.0.2
+sphinxcontrib-devhelp==1.0.2
+sphinxcontrib-htmlhelp==1.0.3
+sphinxcontrib-jsmath==1.0.1
+sphinxcontrib-qthelp==1.0.3
+sphinxcontrib-serializinghtml==1.1.4
+tornado==6.0.4
+urllib3==1.25.8
+watchdog==0.10.2
+Werkzeug==0.15.5