Browse Source

improve documentation structure

Julius Pfrommer 10 years ago
parent
commit
eb8855f48b
6 changed files with 11 additions and 4 deletions
  1. 1 1
      doc/Doxyfile.in
  2. 5 1
      include/ua_connection.h
  3. 2 0
      include/ua_log.h
  4. 1 0
      src/server/ua_services.h
  5. 1 1
      src/ua_securechannel.h
  6. 1 1
      src/ua_session.h

+ 1 - 1
doc/Doxyfile.in

@@ -805,7 +805,7 @@ EXCLUDE_SYMLINKS       = YES
 # Note that the wildcards are matched against the file with absolute path, so to
 # exclude all test directories for example use the pattern */test/*
 
-EXCLUDE_PATTERNS       = */cov-int/*
+EXCLUDE_PATTERNS       = */cov-int/* */ongoing/*
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the

+ 5 - 1
include/ua_connection.h

@@ -22,7 +22,11 @@ extern "C" {
 
 #include "ua_types.h"
 
-/** @defgroup connection Connection */
+/** @defgroup communication Communication */
+
+/**
+ * @ingroup communication
+ * @defgroup connection Connection */
 
 /** Used for zero-copy communication. The array of bytestrings is sent over the
    network as a single buffer. */

+ 2 - 0
include/ua_log.h

@@ -23,6 +23,8 @@ extern "C" {
 #include "ua_config.h"
 
 /**
+ * @ingroup server
+ *
  * @defgroup logging Logging
  *
  * @brief Logging functionality is externally provided to the open62541 libary.

+ 1 - 0
src/server/ua_services.h

@@ -7,6 +7,7 @@
 #include "ua_session.h"
 
 /**
+ * @ingroup server
  * @defgroup services Services
  *
  * @brief This module describes all the services used to communicate in in OPC UA.

+ 1 - 1
src/ua_securechannel.h

@@ -7,7 +7,7 @@
 #include "ua_connection.h"
 
 /**
- *  @ingroup internal
+ *  @ingroup communication
  *
  *  @defgroup securechannel SecureChannel
  */

+ 1 - 1
src/ua_session.h

@@ -5,7 +5,7 @@
 #include "ua_securechannel.h"
 
 /**
- *  @ingroup internal
+ *  @ingroup communication
  *
  *  @defgroup session Session
  */