From 88f5c4214a130f2e39716e804e16a0deaeee7856 Mon Sep 17 00:00:00 2001 From: Thomas Kunze Date: Mon, 27 May 2019 20:08:04 +0200 Subject: [PATCH] remove @brief and enable JAVADOC_AUTOBRIEF in doxygen --- doc/Doxyfile | 2 +- src/knx/address_table_object.h | 12 ++++++------ src/knx/interface_object.h | 16 ++++++++-------- src/knx/save_restore.h | 6 +++--- src/knx/table_object.h | 18 +++++++++--------- 5 files changed, 27 insertions(+), 27 deletions(-) diff --git a/doc/Doxyfile b/doc/Doxyfile index 1ddc49b..b28a123 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -187,7 +187,7 @@ SHORT_NAMES = NO # description.) # The default value is: NO. -JAVADOC_AUTOBRIEF = NO +JAVADOC_AUTOBRIEF = YES # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If diff --git a/src/knx/address_table_object.h b/src/knx/address_table_object.h index a89971f..8756af5 100644 --- a/src/knx/address_table_object.h +++ b/src/knx/address_table_object.h @@ -2,7 +2,7 @@ #include "table_object.h" /** - * @brief This class represents the group address table. It provides a mapping between tranport layer + * This class represents the group address table. It provides a mapping between tranport layer * service access points (TSAP) and group addresses. The TSAP can be imagined as an index to the array * of group adresses. * @@ -13,7 +13,7 @@ class AddressTableObject: public TableObject { public: /** - * @brief The contructor. + * The contructor. * @param platform This parameter is only passed to the custructor of TableObject an not used by this class. */ AddressTableObject(Platform& platform); @@ -21,11 +21,11 @@ public: uint8_t *save(uint8_t *buffer); uint8_t *restore(uint8_t *buffer); /** - * @brief returns the number of group addresses of the object. + * returns the number of group addresses of the object. */ uint16_t entryCount(); /** - * @brief Get the group address mapped to a TSAP. + * Get the group address mapped to a TSAP. * * @param tsap The TSAP of which to get the group address for. * @@ -33,7 +33,7 @@ public: */ uint16_t getGroupAddress(uint16_t tsap); /** - * @brief Get the TSAP mapped to a group address. + * Get the TSAP mapped to a group address. * * @param groupAddress the group address of whicht to get the TSAP for. * @@ -41,7 +41,7 @@ public: */ uint16_t getTsap(uint16_t groupAddress); /** - * @brief Check if the address table contains a group address. + * Check if the address table contains a group address. * * @param groupAddress the group address to check * diff --git a/src/knx/interface_object.h b/src/knx/interface_object.h index bdcb97d..e1fcb72 100644 --- a/src/knx/interface_object.h +++ b/src/knx/interface_object.h @@ -51,17 +51,17 @@ enum ObjectType }; /** - * @brief This class represents and interface object. See section 4 of @cite knx:3/4/1. + * This class represents and interface object. See section 4 of @cite knx:3/4/1. */ class InterfaceObject: public SaveRestore { public: /** - * @brief Destructor + * Destructor */ virtual ~InterfaceObject() {} /** - * @brief Read a property of the interface object. See section 4.8.4.2 of @cite knx:3/4/1. + * Read a property of the interface object. See section 4.8.4.2 of @cite knx:3/4/1. * * @param id id of the property to read * @@ -74,7 +74,7 @@ public: */ virtual void readProperty(PropertyID id, uint32_t start, uint32_t& count, uint8_t* data); /** - * @brief Write property of the interface object. If the interface object does not have the property this + * Write property of the interface object. If the interface object does not have the property this * method does nothing. See section 4.8.4.4 of @cite knx:3/4/1. * * @param id id of the property to write @@ -87,7 +87,7 @@ public: */ virtual void writeProperty(PropertyID id, uint8_t start, uint8_t* data, uint8_t count); /** - * @brief Gets the size of of property in bytes. + * Gets the size of of property in bytes. * * @param id of the property to get the size of * @@ -95,7 +95,7 @@ public: */ virtual uint8_t propertySize(PropertyID id); /** - * @brief Read the Description of a property of the interface object. The output parameters are only valid if nuberOfElements is not zero. + * Read the Description of a property of the interface object. The output parameters are only valid if nuberOfElements is not zero. * * @param[in,out] propertyId The id of the property of which to read the description of. If this parameter is not zero * propertyIndex paramter is ignored as input and the corrrect index of the property is written to it. If this @@ -116,11 +116,11 @@ public: void readPropertyDescription(uint8_t& propertyId, uint8_t& propertyIndex, bool& writeEnable, uint8_t& type, uint16_t& numberOfElements, uint8_t& access); protected: /** - * @brief Returns the number of properties the interface object has. + * Returns the number of properties the interface object has. */ virtual uint8_t propertyCount(); /** - * @brief Returns a pointer to the first PropertyDescription of the interface object. + * Returns a pointer to the first PropertyDescription of the interface object. * This is used by readPropertyDescription() together with propertyCount(). */ virtual PropertyDescription* propertyDescriptions(); diff --git a/src/knx/save_restore.h b/src/knx/save_restore.h index fd61e88..31bba83 100644 --- a/src/knx/save_restore.h +++ b/src/knx/save_restore.h @@ -2,13 +2,13 @@ #include /** - * @brief Interface for classes that can save and restore data from a buffer. + * Interface for classes that can save and restore data from a buffer. */ class SaveRestore { public: /** - * @brief This method is called when the object should save its state to the buffer. + * This method is called when the object should save its state to the buffer. * * @param buffer The buffer the object should save its state to. * @@ -17,7 +17,7 @@ public: */ virtual uint8_t* save(uint8_t* buffer) = 0; /** - * @brief This method is called when the object should restore its state from the buffer. + * This method is called when the object should restore its state from the buffer. * * @param buffer The buffer the object should restore its state from. * diff --git a/src/knx/table_object.h b/src/knx/table_object.h index 291c33f..1a35395 100644 --- a/src/knx/table_object.h +++ b/src/knx/table_object.h @@ -4,13 +4,13 @@ #include "platform.h" /** - * @brief This class provides common functionality for interface objects that are configured by ETS with MemorWrite. + * This class provides common functionality for interface objects that are configured by ETS with MemorWrite. */ class TableObject: public InterfaceObject { public: /** - * @brief The constuctor. + * The constuctor. * @param platform the Platform on which the software runs. The class uses the memory management features of Platform. */ TableObject(Platform& platform); @@ -18,34 +18,34 @@ public: virtual void writeProperty(PropertyID id, uint8_t start, uint8_t* data, uint8_t count); virtual uint8_t propertySize(PropertyID id); /** - * @brief The destructor. + * The destructor. */ virtual ~TableObject(); /** - * @brief This method returns the ::LoadState of the interface object. + * This method returns the ::LoadState of the interface object. */ LoadState loadState(); virtual uint8_t* save(uint8_t* buffer); virtual uint8_t* restore(uint8_t* buffer); protected: /** - * @brief This method is called before the interface object enters a new ::Loadstate. + * This method is called before the interface object enters a new ::Loadstate. * If there is a error changing the state newState should be set to ::LS_ERROR and errorCode() * to a reason for the failure. */ virtual void beforeStateChange(LoadState& newState) {} /** - * @brief returns the internal data of the interface object. This pointer belongs to the TableObject class and + * returns the internal data of the interface object. This pointer belongs to the TableObject class and * must not be freed. */ uint8_t* data(); /** - * @brief returns the size of the internal data of the interface object int byte. + * returns the size of the internal data of the interface object int byte. */ uint32_t size(); /** - * @brief Set the reason for a state change failure. + * Set the reason for a state change failure. */ void errorCode(ErrorCode errorCode); @@ -59,7 +59,7 @@ protected: void loadEventError(uint8_t* data); void additionalLoadControls(uint8_t* data); /** - * @brief set the ::LoadState of the interface object. + * set the ::LoadState of the interface object. * * Calls beforeStateChange(). *