Improve doxygen documentation (#229)
* Improve doxygen documentation * Uncrustify * Fix path Co-authored-by: Pablo Garrido <pablogs9@gmail.com>
This commit is contained in:
Antonio Cuadros
GitHub
parent
8420d72d52
commit
0591d3bca7
12
doxyfile.in
12
doxyfile.in
|
|
@ -666,7 +666,7 @@ FILE_VERSION_FILTER =
|
|||
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
|
||||
# tag is left empty.
|
||||
|
||||
LAYOUT_FILE =
|
||||
LAYOUT_FILE = "@PROJECT_SOURCE_DIR@/utils/doxygen/pages/DoxygenLayout.xml"
|
||||
|
||||
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
|
||||
# the reference definitions. This must be a list of .bib files. The .bib
|
||||
|
|
@ -755,8 +755,7 @@ WARN_LOGFILE =
|
|||
# Note: If this tag is empty the current directory is searched.
|
||||
|
||||
INPUT = "@PROJECT_SOURCE_DIR@/include" \
|
||||
"@PROJECT_SOURCE_DIR@/utils/doxygen/pages" \
|
||||
"@PROJECT_SOURCE_DIR@/utils/doxygenfiles/mainpage.dox
|
||||
"@PROJECT_SOURCE_DIR@/utils/doxygen/pages"
|
||||
|
||||
# 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
|
||||
|
|
@ -877,8 +876,7 @@ EXAMPLE_RECURSIVE = NO
|
|||
# that contain images that are to be included in the documentation (see the
|
||||
# \image command).
|
||||
|
||||
IMAGE_PATH = "@PROJECT_SOURCE_DIR@/utils/images/logo" #\
|
||||
#"@PROJECT_SOURCE_DIR@/utils/doxygen/pages"
|
||||
IMAGE_PATH = "@PROJECT_SOURCE_DIR@/utils/images/logo"
|
||||
|
||||
# The INPUT_FILTER tag can be used to specify a program that doxygen should
|
||||
# invoke to filter for each input file. Doxygen will invoke the filter program
|
||||
|
|
@ -1048,7 +1046,7 @@ GENERATE_HTML = YES
|
|||
# The default directory is: html.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_OUTPUT = "@PROJECT_SOURCE_DIR@/build/doc/api_reference"
|
||||
HTML_OUTPUT = "@PROJECT_BINARY_DIR@/doc/api_reference"
|
||||
|
||||
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
|
||||
# generated HTML page (for example: .htm, .php, .asp).
|
||||
|
|
@ -1375,7 +1373,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project
|
|||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
DISABLE_INDEX = NO
|
||||
DISABLE_INDEX = YES
|
||||
|
||||
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
|
||||
# structure should be generated to display hierarchical information. If the tag
|
||||
|
|
|
|||
|
|
@ -26,6 +26,11 @@ extern "C"
|
|||
|
||||
#include <uxr/client/core/session/session.h>
|
||||
|
||||
/** \addtogroup create_common Create entities common profile
|
||||
* These functions are enabled when either PROFILE_CREATE_ENTITIES_XML or PROFILE_CREATE_ENTITIES_REF are activated as CMake arguments. The declaration of these functions can be found in uxr/client/profile/session/common_create_entities.h.
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Buffers into the stream identified by `stream_id` an XRCE DELETE submessage.
|
||||
* The submessage will be sent when `uxr_flash_output_stream` or `uxr_run_session` function are called.
|
||||
|
|
@ -41,6 +46,8 @@ UXRDLLAPI uint16_t uxr_buffer_delete_entity(
|
|||
uxrStreamId stream_id,
|
||||
uxrObjectId object_id);
|
||||
|
||||
/** @}*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif // ifdef __cplusplus
|
||||
|
|
|
|||
|
|
@ -26,6 +26,11 @@ extern "C"
|
|||
|
||||
#include <uxr/client/core/session/common_create_entities.h>
|
||||
|
||||
/** \addtogroup create_ref Create entities by reference
|
||||
* These functions are enabled when PROFILE_CREATE_ENTITIES_REF is activated as a CMake argument. The declaration of these functions can be found in uxr/client/profile/session/create_entities_ref.h.
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Buffers into the stream identified by `stream_id` an XRCE CREATE submessage with an XRCE Participant payload.
|
||||
* The submessage will be sent when `uxr_flash_output_streams` or `uxr_run_session` function are called.
|
||||
|
|
@ -172,6 +177,8 @@ UXRDLLAPI uint16_t uxr_buffer_create_replier_ref(
|
|||
const char* ref,
|
||||
uint8_t mode);
|
||||
|
||||
/** @}*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif // ifdef __cplusplus
|
||||
|
|
|
|||
|
|
@ -26,6 +26,11 @@ extern "C"
|
|||
|
||||
#include <uxr/client/core/session/common_create_entities.h>
|
||||
|
||||
/** \addtogroup create_xml Create entities by XML
|
||||
* These functions are enabled when the PROFILE_CREATE_ENTITIES_XML is activated as a CMake argument. The declaration of these functions can be found in uxr/client/profile/session/create_entities_xml.h.
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Buffers into the stream identified by `stream_id` an XRCE CREATE submessage with an XRCE Participant payload.
|
||||
* The submessage will be sent when `uxr_flash_output_streams` or `uxr_run_session` function are called.
|
||||
|
|
@ -220,6 +225,8 @@ UXRDLLAPI uint16_t uxr_buffer_create_replier_xml(
|
|||
const char* xml,
|
||||
uint8_t mode);
|
||||
|
||||
/** @}*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif // ifdef __cplusplus
|
||||
|
|
|
|||
|
|
@ -47,6 +47,7 @@ typedef struct uxrObjectId
|
|||
|
||||
/**
|
||||
* @brief This function creates an identifier to reference an entity.
|
||||
* @ingroup general_utils
|
||||
* @param id Identifier of the object, different for each type. There can be several objects with the same ID, provided they have different types.
|
||||
* @param type The type of the entity. It can be: UXR_PARTICIPANT_ID, UXR_TOPIC_ID, UXR_PUBLISHER_ID, UXR_SUBSCRIBER_ID, UXR_DATAWRITER_ID, UXR_DATAREADER_ID, UXR_REQUESTER_ID, or UXR_REPLIER_ID.
|
||||
* @return Generated entity identifier.
|
||||
|
|
|
|||
|
|
@ -30,19 +30,32 @@ extern "C"
|
|||
#define UXR_MAX_ELAPSED_TIME_UNLIMITED 0x0000
|
||||
#define UXR_MAX_BYTES_PER_SECOND_UNLIMITED 0x0000
|
||||
|
||||
|
||||
/**
|
||||
* @brief A structure used for controlling the delivery of topic from the Agent to the Client.
|
||||
/** \addtogroup read Read access
|
||||
* The Read Access is used by the Client to handle the read operation on the Agent. The declaration of these functions can be found in uxr/client/profile/session/read_access.h.
|
||||
* @{
|
||||
*/
|
||||
|
||||
/** @struct uxrDeliveryControl
|
||||
* @brief A structure used for controlling the delivery of topic from the Agent to the Client.
|
||||
*
|
||||
* @var uxrDeliveryControl::max_samples
|
||||
* The maximum number of topics that the Agent shall send to the Client.
|
||||
*
|
||||
* @var uxrDeliveryControl::max_elapsed_time
|
||||
* The maximum amount of time in seconds that shall be spent by the Agent delivering the topic.
|
||||
*
|
||||
* @var uxrDeliveryControl::max_bytes_per_second
|
||||
* The maximum transfer rate, in bytes per second, that the Agent shall use.
|
||||
*
|
||||
* @var uxrDeliveryControl::min_pace_period
|
||||
* The minimum elapsed time, in milliseconds, between two topics deliveries.
|
||||
*/
|
||||
|
||||
typedef struct uxrDeliveryControl
|
||||
{
|
||||
/** The maximum number of topics that the Agent shall send to the Client. */
|
||||
uint16_t max_samples;
|
||||
/** The maximum amount of time in seconds that shall be spent by the Agent delivering the topic. */
|
||||
uint16_t max_elapsed_time;
|
||||
/** The maximum transfer rate, in bytes per second, that the Agent shall use. */
|
||||
uint16_t max_bytes_per_second;
|
||||
/** The minimum elapsed time, in milliseconds, between two topics deliveries. */
|
||||
uint16_t min_pace_period;
|
||||
|
||||
} uxrDeliveryControl;
|
||||
|
|
@ -89,6 +102,8 @@ UXRDLLAPI uint16_t uxr_buffer_cancel_data(
|
|||
uxrStreamId stream_id,
|
||||
uxrObjectId datareader_id);
|
||||
|
||||
/** @}*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif // ifdef __cplusplus
|
||||
|
|
|
|||
|
|
@ -33,6 +33,12 @@ extern "C"
|
|||
struct uxrSession;
|
||||
struct uxrCommunication;
|
||||
|
||||
/** \addtogroup session Session
|
||||
* These functions are available even if no profile has been enabled. The declaration of these functions can be found in uxr/client/core/session/session.h.
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
||||
/**
|
||||
* @brief Function signature used for on_status_func callbacks.
|
||||
* @param session Session structure related to the status.
|
||||
|
|
@ -130,12 +136,18 @@ typedef bool (* uxrOnBuffersFull) (
|
|||
struct uxrSession* session);
|
||||
|
||||
#ifdef PERFORMANCE_TESTING
|
||||
/**
|
||||
* @nosubgrouping
|
||||
*/
|
||||
typedef void (* uxrOnPerformanceFunc) (
|
||||
struct uxrSession* session,
|
||||
struct ucdrBuffer* mb,
|
||||
void* args);
|
||||
#endif // ifdef PERFORMANCE_TESTING
|
||||
|
||||
/**
|
||||
* @nosubgrouping
|
||||
*/
|
||||
typedef struct uxrContinuousArgs
|
||||
{
|
||||
uxrOnBuffersFull flush_callback;
|
||||
|
|
@ -143,6 +155,9 @@ typedef struct uxrContinuousArgs
|
|||
size_t data_size;
|
||||
} uxrContinuousArgs;
|
||||
|
||||
/**
|
||||
* @nosubgrouping
|
||||
*/
|
||||
typedef struct uxrSession
|
||||
{
|
||||
uxrSessionInfo info;
|
||||
|
|
@ -259,6 +274,9 @@ UXRDLLAPI void uxr_set_reply_callback(
|
|||
void* args);
|
||||
|
||||
#ifdef PERFORMANCE_TESTING
|
||||
/**
|
||||
* @nosubgrouping
|
||||
*/
|
||||
UXRDLLAPI void uxr_set_performance_callback(
|
||||
uxrSession* session,
|
||||
uxrOnPerformanceFunc on_performance_func,
|
||||
|
|
@ -516,6 +534,9 @@ UXRDLLAPI int64_t uxr_epoch_nanos(
|
|||
uxrSession* session);
|
||||
|
||||
#ifdef PERFORMANCE_TESTING
|
||||
/**
|
||||
* @nosubgrouping
|
||||
*/
|
||||
UXRDLLAPI bool uxr_buffer_performance(
|
||||
uxrSession* session,
|
||||
uxrStreamId stream_id,
|
||||
|
|
@ -525,6 +546,8 @@ UXRDLLAPI bool uxr_buffer_performance(
|
|||
bool echo);
|
||||
#endif // ifdef PERFORMANCE_TESTING
|
||||
|
||||
/** @}*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif // ifdef __cplusplus
|
||||
|
|
|
|||
|
|
@ -27,6 +27,11 @@ extern "C"
|
|||
#include <uxr/client/visibility.h>
|
||||
#include <stdint.h>
|
||||
|
||||
/** \addtogroup general_utils General utilities
|
||||
* Utility functions. The declaration of these functions can be found in uxr/client/core/session/stream_id.h and uxr/client/core/session/object_id.h.
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* The enum that identifies the kind of stream.
|
||||
* According to the XRCE standard, a stream represents an independent flow of messages within a session.
|
||||
|
|
@ -65,6 +70,9 @@ typedef enum uxrStreamDirection
|
|||
|
||||
} uxrStreamDirection;
|
||||
|
||||
/**
|
||||
* @nosubgrouping
|
||||
*/
|
||||
typedef struct uxrStreamId
|
||||
{
|
||||
uint8_t raw;
|
||||
|
|
@ -102,6 +110,8 @@ UXRDLLAPI uxrStreamId uxr_stream_id_from_raw(
|
|||
uint8_t stream_id_raw,
|
||||
uxrStreamDirection direction);
|
||||
|
||||
/** @}*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif // ifdef __cplusplus
|
||||
|
|
|
|||
|
|
@ -26,6 +26,11 @@ extern "C"
|
|||
|
||||
#include <uxr/client/core/session/session.h>
|
||||
|
||||
/** \addtogroup write Write access profile
|
||||
* The Write Access is used by the Client to handle the write operation on the Agent. The declaration of these functions can be found in uxr/client/profile/session/write_access.h.
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Buffers into the stream identified by `stream_id` an XRCE WRITE_DATA submessage.
|
||||
* As a consequence, an XRCE request is generated associated to the WRITE_DATA submessage.
|
||||
|
|
@ -129,6 +134,8 @@ UXRDLLAPI uint16_t uxr_prepare_output_stream_fragmented(
|
|||
size_t topic_size,
|
||||
uxrOnBuffersFull flush_callback);
|
||||
|
||||
/** @}*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif // ifdef __cplusplus
|
||||
|
|
|
|||
|
|
@ -32,6 +32,12 @@ extern "C"
|
|||
#include <stdbool.h>
|
||||
#include <stddef.h>
|
||||
|
||||
/** \addtogroup discovery Discovery profile
|
||||
* The discovery profile allows discovering Agents in the network by UDP. The reachable Agents respond to the discovery call by sending information about themselves, as their IP and port. There are two modes: unicast and multicast. The discovery phase precedes the call to the uxr_create_session function, as it serves to determine the Agent to connect with. These functions are enabled when PROFILE_DISCOVERY is activated as a CMake argument. The declaration of these functions can be found in uxr/client/profile/discovery/discovery.h.
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
||||
/**
|
||||
* @brief Function signature used for on_status_func callbacks.
|
||||
* @param locator Transport locator of a discovered agent
|
||||
|
|
@ -72,6 +78,8 @@ UXRDLLAPI void uxr_discovery_agents(
|
|||
const TransportLocator* agent_list,
|
||||
size_t agent_list_size);
|
||||
|
||||
/** @}*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif // ifdef __cplusplus
|
||||
|
|
|
|||
|
|
@ -31,6 +31,11 @@ extern "C"
|
|||
|
||||
struct uxrCustomTransport;
|
||||
|
||||
/** \addtogroup transport Transport
|
||||
* These functions are platform-dependent. The declaration of these functions can be found in the uxr/client/profile/transport/ folder. The common init transport functions follow the nomenclature below.
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Function signature callback for opening a custom transport.
|
||||
* @param transport Custom transport structure. Has the args passed through bool uxr_init_custom_transport(uxrCustomTransport* transport, void * args);.
|
||||
|
|
@ -78,6 +83,10 @@ typedef size_t (* read_custom_func) (
|
|||
int timeout,
|
||||
uint8_t* error_code);
|
||||
|
||||
/**
|
||||
* @nosubgrouping
|
||||
*/
|
||||
|
||||
typedef struct uxrCustomTransport
|
||||
{
|
||||
uint8_t buffer[UXR_CONFIG_CUSTOM_TRANSPORT_MTU];
|
||||
|
|
@ -128,6 +137,8 @@ UXRDLLAPI bool uxr_init_custom_transport(
|
|||
UXRDLLAPI bool uxr_close_custom_transport(
|
||||
uxrCustomTransport* transport);
|
||||
|
||||
/** @}*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif // ifdef __cplusplus
|
||||
|
|
|
|||
|
|
@ -34,6 +34,11 @@ typedef enum uxrIpProtocol
|
|||
|
||||
} uxrIpProtocol;
|
||||
|
||||
/** \addtogroup transport Transport
|
||||
* These functions are platform-dependent. The declaration of these functions can be found in the uxr/client/profile/transport/ folder. The common init transport functions follow the nomenclature below.
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Converts IPv4/IPv6 address + port to a TransportLocator.
|
||||
*
|
||||
|
|
@ -71,6 +76,8 @@ UXRDLLAPI bool uxr_locator_to_ip(
|
|||
uint16_t* port,
|
||||
uxrIpProtocol* ip_protocol);
|
||||
|
||||
/** @}*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif // ifdef __cplusplus
|
||||
|
|
|
|||
|
|
@ -56,6 +56,11 @@ typedef struct uxrTCPTransport
|
|||
|
||||
} uxrTCPTransport;
|
||||
|
||||
/** \addtogroup transport Transport
|
||||
* These functions are platform-dependent. The declaration of these functions can be found in the uxr/client/profile/transport/ folder. The common init transport functions follow the nomenclature below.
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Initializes a TCP transport.
|
||||
* @param transport The uninitialized transport structure used for managing the transport.
|
||||
|
|
@ -79,6 +84,8 @@ UXRDLLAPI bool uxr_init_tcp_transport(
|
|||
UXRDLLAPI bool uxr_close_tcp_transport(
|
||||
uxrTCPTransport* transport);
|
||||
|
||||
/** @}*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif // ifdef __cplusplus
|
||||
|
|
|
|||
|
|
@ -37,6 +37,11 @@ typedef struct uxrUDPTransport
|
|||
struct uxrUDPPlatform platform;
|
||||
} uxrUDPTransport;
|
||||
|
||||
/** \addtogroup transport Transport
|
||||
* These functions are platform-dependent. The declaration of these functions can be found in the uxr/client/profile/transport/ folder. The common init transport functions follow the nomenclature below.
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Initializes a UDP transport.
|
||||
* @param transport The uninitialized transport structure used for managing the transport.
|
||||
|
|
@ -60,6 +65,7 @@ UXRDLLAPI bool uxr_init_udp_transport(
|
|||
UXRDLLAPI bool uxr_close_udp_transport(
|
||||
uxrUDPTransport* transport);
|
||||
|
||||
/** @}*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
|
|
|
|||
|
|
@ -40,6 +40,10 @@ typedef struct uxrSerialTransport
|
|||
|
||||
} uxrSerialTransport;
|
||||
|
||||
/** \addtogroup transport Transport
|
||||
* These functions are platform-dependent. The declaration of these functions can be found in the uxr/client/profile/transport/ folder. The common init transport functions follow the nomenclature below.
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Initializes a UDP transport.
|
||||
|
|
@ -66,6 +70,8 @@ UXRDLLAPI bool uxr_init_serial_transport(
|
|||
UXRDLLAPI bool uxr_close_serial_transport(
|
||||
uxrSerialTransport* transport);
|
||||
|
||||
/** @}*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif // ifdef __cplusplus
|
||||
|
|
|
|||
|
|
@ -40,6 +40,7 @@ extern "C"
|
|||
* This methods performs a single attempt.
|
||||
* Transport must be properly initialized before calling this method.
|
||||
* This method does not take care of init/fini the transport struct.
|
||||
* @ingroup general_utils
|
||||
* @param comm Pointer to the uxrCommunication struct holding the transport
|
||||
* information and callback methods.
|
||||
* @param timeout Time, in milliseconds, for a ping attempt.
|
||||
|
|
@ -56,6 +57,7 @@ UXRDLLAPI bool uxr_ping_agent(
|
|||
* successful ping occurs.
|
||||
* Transport must be properly initialized before calling this method.
|
||||
* This method does not take care of init/fini the transport struct.
|
||||
* @ingroup general_utils
|
||||
* @param comm Pointer to the uxrCommunication struct holding the transport
|
||||
* information and callback methods.
|
||||
* @param timeout Time, in milliseconds, for a ping attempt.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,121 @@
|
|||
<doxygenlayout version="1.0">
|
||||
<!-- Navigation index tabs for HTML output -->
|
||||
<navindex>
|
||||
<tab type="mainpage" visible="yes" title=""/>
|
||||
<tab type="pages" visible="yes" title="" intro=""/>
|
||||
<tab type="modules" visible="yes" title="API reference" intro=""/>
|
||||
<tab type="namespaces" visible="yes" title="">
|
||||
<tab type="namespacelist" visible="yes" title="" intro=""/>
|
||||
<tab type="namespacemembers" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="classes" visible="no" title="">
|
||||
<tab type="classlist" visible="no" title="" intro=""/>
|
||||
<tab type="classindex" visible="no" title=""/>
|
||||
<tab type="hierarchy" visible="no" title="" intro=""/>
|
||||
<tab type="classmembers" visible="no" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="files" visible="no" title="API reference">
|
||||
<tab type="filelist" visible="no" title="" intro=""/>
|
||||
<tab type="globals" visible="no" title="Functions" intro=""/>
|
||||
</tab>
|
||||
<tab type="dirs" visible="no" title="" intro=""/>
|
||||
<tab type="examples" visible="no" title="" intro=""/>
|
||||
</navindex>
|
||||
|
||||
<!-- Layout definition for a group page -->
|
||||
<group>
|
||||
<briefdescription visible="yes"/>
|
||||
<groupgraph visible="$GROUP_GRAPHS"/>
|
||||
<memberdecl>
|
||||
<classes visible="yes" title="Data Structures"/>
|
||||
<namespaces visible="yes" title=""/>
|
||||
<dirs visible="yes" title=""/>
|
||||
<nestedgroups visible="yes" title=""/>
|
||||
<files visible="no" title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title="Typedef List"/>
|
||||
<enums title="Enumeration List"/>
|
||||
<enumvalues title=""/>
|
||||
<functions title="Function List"/>
|
||||
<!-- <variables title=""/> -->
|
||||
<signals title=""/>
|
||||
<publicslots title=""/>
|
||||
<protectedslots title=""/>
|
||||
<privateslots title=""/>
|
||||
<events title=""/>
|
||||
<properties title=""/>
|
||||
<friends title=""/>
|
||||
</memberdecl>
|
||||
<memberdef>
|
||||
<defines title=""/>
|
||||
<typedefs title="Typedef Details"/>
|
||||
<enums title="Enumeration Details"/>
|
||||
<enumvalues title=""/>
|
||||
<functions title="Function Details"/>
|
||||
<!-- <variables title=""/> -->
|
||||
<signals title=""/>
|
||||
<publicslots title=""/>
|
||||
<protectedslots title=""/>
|
||||
<privateslots title=""/>
|
||||
<events title=""/>
|
||||
<properties title=""/>
|
||||
<friends title=""/>
|
||||
</memberdef>
|
||||
<authorsection visible="yes"/>
|
||||
</group>
|
||||
|
||||
<!-- Layout definition for a class page -->
|
||||
<!-- Also used for structs -->
|
||||
<class>
|
||||
<briefdescription visible="yes"/>
|
||||
<includes visible="$SHOW_INCLUDE_FILES"/>
|
||||
<inheritancegraph visible="$CLASS_GRAPH"/>
|
||||
<allmemberslink visible="yes"/>
|
||||
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
|
||||
<memberdecl>
|
||||
<membergroups visible="yes"/>
|
||||
<nestedclasses visible="yes" title=""/>
|
||||
<publictypes title=""/>
|
||||
<publicslots title=""/>
|
||||
<signals title=""/>
|
||||
<publicmethods title=""/>
|
||||
<publicstaticmethods title=""/>
|
||||
<publicattributes title="Data Fields List"/>
|
||||
<publicstaticattributes title=""/>
|
||||
<protectedtypes title=""/>
|
||||
<protectedslots title=""/>
|
||||
<protectedmethods title=""/>
|
||||
<protectedstaticmethods title=""/>
|
||||
<protectedattributes title=""/>
|
||||
<protectedstaticattributes title=""/>
|
||||
<packagetypes title=""/>
|
||||
<packagemethods title=""/>
|
||||
<packagestaticmethods title=""/>
|
||||
<packageattributes title=""/>
|
||||
<packagestaticattributes title=""/>
|
||||
<properties title=""/>
|
||||
<events title=""/>
|
||||
<privatetypes title=""/>
|
||||
<privateslots title=""/>
|
||||
<privatemethods title=""/>
|
||||
<privatestaticmethods title=""/>
|
||||
<privateattributes title=""/>
|
||||
<privatestaticattributes title=""/>
|
||||
<friends title=""/>
|
||||
<related title="" subtitle=""/>
|
||||
</memberdecl>
|
||||
<memberdef>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<constructors title=""/>
|
||||
<functions title=""/>
|
||||
<related title=""/>
|
||||
<variables title="Data Fields Details"/>
|
||||
<properties title=""/>
|
||||
<events title=""/>
|
||||
</memberdef>
|
||||
<usedfiles visible="$SHOW_USED_FILES"/>
|
||||
<authorsection visible="yes"/>
|
||||
</class>
|
||||
|
||||
</doxygenlayout>
|
||||
Loading…
Reference in New Issue