some docs added

eclipse-zenoh · Jul 28, 2023 · 21e81a1 · 21e81a1
1 parent a27e369
commit 21e81a1
Show file tree

Hide file tree

Showing 8 changed files with 264 additions and 129 deletions.
diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
@@ -26,16 +26,21 @@ set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/html/index.html)
 set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
 set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
 
-file(GLOB_RECURSE HEADERS ${DOXYGEN_INPUT_DIR}/*.hxx)
+# file(GLOB_RECURSE HEADERS ${DOXYGEN_INPUT_DIR}/*.hxx)
+set(DOXYGEN_INPUT_FILES 
+${DOXYGEN_INPUT_DIR}/zenohcxx/base.hxx 
+${DOXYGEN_INPUT_DIR}/zenohcxx/api.hxx
+)
 
+list(JOIN DOXYGEN_INPUT_FILES " " DOXYGEN_INPUT_FILES_CFG)
 configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY)
 
 #This will be the main output of our command
 set(DOXYGEN_INDEX_FILE ${CMAKE_CURRENT_SOURCE_DIR}/html/index.html)
 
 file(MAKE_DIRECTORY ${DOXYGEN_OUTPUT_DIR})
 add_custom_command(OUTPUT ${DOXYGEN_INDEX_FILE}
-                   DEPENDS ${HEADERS}
+                   DEPENDS ${DOXYGEN_INPUT_FILES}
                    COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT}
                    MAIN_DEPENDENCY ${DOXYFILE_OUT} ${DOXYFILE_IN}
                    COMMENT "Generating docs")

diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in
@@ -943,7 +943,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = "@DOXYGEN_INPUT_DIR@"
+INPUT                  = @DOXYGEN_INPUT_FILES_CFG@
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -2303,7 +2303,7 @@ PERLMOD_MAKEVAR_PREFIX =
 # C-preprocessor directives found in the sources and include files.
 # The default value is: YES.
 
-ENABLE_PREPROCESSING   = YES
+ENABLE_PREPROCESSING   = NO
 
 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
 # in the source code. If set to NO, only conditional compilation will be
@@ -2353,7 +2353,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             =
+PREDEFINED             = __ZENOHCXX_ZENOHPICO __ZENOHCXX_ZENOHC
 
 # 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

diff --git a/docs/api.rst b/docs/api.rst
@@ -16,14 +16,9 @@
 API Reference
 *************
 
-Generic types
-=============
+.. toctree::
+    :maxdepth: 10
 
-.. doxygentypedef:: ErrorMessage
-
-.. doxygentypedef:: ErrNo
-
-.. doxygentypedef:: SampleKind
-
-.. doxygenstruct:: StrArrayView
-   :members:
+    enums
+    copyable
+    utility
diff --git a/docs/copyable.rst b/docs/copyable.rst
@@ -0,0 +1,32 @@
+..
+.. Copyright (c) 2023 ZettaScale Technology
+..
+.. This program and the accompanying materials are made available under the
+.. terms of the Eclipse Public License 2.0 which is available at
+.. http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
+.. which is available at https://www.apache.org/licenses/LICENSE-2.0.
+..
+.. SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
+..
+.. Contributors:
+..   ZettaScale Zenoh Team, <zenoh@zettascale.tech>
+..
+
+Copyable types
+==============
+
+Copyable types are the types which can be freely copied and passed by value.
+They either don't reference external resources or they reference resources 
+without taking ownership.
+
+All these types are based on `Copyable` template.
+
+.. doxygenstruct:: zenohcxx::Copyable
+   :members:
+
+.. doxygenclass:: BytesView
+   :members:
+
+.. doxygenstruct:: StrArrayView
+.. doxygenstruct:: _StrArrayView
+   :members:
diff --git a/docs/enums.rst b/docs/enums.rst
@@ -0,0 +1,44 @@
+..
+.. Copyright (c) 2023 ZettaScale Technology
+..
+.. This program and the accompanying materials are made available under the
+.. terms of the Eclipse Public License 2.0 which is available at
+.. http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
+.. which is available at https://www.apache.org/licenses/LICENSE-2.0.
+..
+.. SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
+..
+.. Contributors:
+..   ZettaScale Zenoh Team, <zenoh@zettascale.tech>
+..
+
+Enums
+=====
+
+Enum types are C++ - style typedefs for corrresponding enums of zenoh-c / zenoh-pico C API.
+
+.. doxygentypedef:: ErrorMessage
+
+.. doxygentypedef:: ErrNo
+
+.. doxygentypedef:: SampleKind
+
+.. doxygentypedef:: EncodingPrefix
+
+.. doxygentypedef:: ConsolidationMode
+
+.. doxygentypedef:: Reliability
+
+.. doxygentypedef:: CongestionControl
+
+.. doxygentypedef:: Priority
+
+.. doxygentypedef:: QueryTarget
+
+.. doxygenfunction:: query_target_default
+
+.. doxygentypedef:: WhatAmI
+See also ::cpp:func:`as_cstr`
+
+.. doxygenenum:: WhatAmI
+See also ::cpp:func:`as_cstr`
diff --git a/docs/utility.rst b/docs/utility.rst
@@ -0,0 +1,20 @@
+..
+.. Copyright (c) 2023 ZettaScale Technology
+..
+.. This program and the accompanying materials are made available under the
+.. terms of the Eclipse Public License 2.0 which is available at
+.. http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
+.. which is available at https://www.apache.org/licenses/LICENSE-2.0.
+..
+.. SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
+..
+.. Contributors:
+..   ZettaScale Zenoh Team, <zenoh@zettascale.tech>
+..
+
+Utility functions
+=================
+
+.. doxygenfunction:: init_logger
+
+.. doxygenfunction:: as_cstr