Changeset 4122410 in mainline for uspace/lib

Timestamp:

2018-08-29T21:26:21Z (7 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

c8ea6eca

Parents:

46f7b64

Message:

Improve Doxygen documentaion

This is stil WiP. A number of libraries, drivers and services were
converted to using a more hierarchical and decentralized scheme when it
comes to specifying to which doxygen group they belong.

Location:

uspace/lib

Files:

• block/doc/doxygroups.h (added)
• c/arch/abs32le/include/libarch/faddr.h (modified) (1 diff)
• c/arch/ppc32/include/libarch/config.h (modified) (1 diff)
• c/arch/riscv64/include/libarch/faddr.h (modified) (1 diff)
• c/doc/doxygroups.h (added)
• c/generic/libc.c (modified) (1 diff)
• clui/doc/doxygroups.h (added)
• clui/tinput.c (modified) (2 diffs)
• dltest/dltest.c (modified) (1 diff)
• dltest/doc/doxygroups.h (added)
• dltest/libdltest.h (modified) (1 diff)
• drv/doc/doxygroups.h (added)
• drv/generic/dev_iface.c (modified) (1 diff)
• drv/generic/driver.c (modified) (1 diff)
• drv/generic/interrupt.c (modified) (1 diff)
• ext4/doc/doxygroups.h (added)
• fdisk/doc/doxygroups.h (added)
• fs/doc/doxygroups.h (added)
• http/doc/doxygroups.h (added)
• ieee80211/doc/doxygroups.h (added)
• label/doc/doxygroups.h (added)
• math/doc/doxygroups.h (added)
• nettl/doc/doxygroups.h (added)
• nic/doc/doxygroups.h (added)
• posix/doc/doxygroups.h (added)
• scsi/doc/doxygroups.h (added)
• sif/doc/doxygroups.h (added)
• softfloat/doc/doxygroups.h (added)
• softint/doc/doxygroups.h (added)
• softrend/doc/doxygroups.h (added)
• trackmod/doc/doxygroups.h (added)
• untar/doc/doxygroups.h (added)
• uri/doc/doxygroups.h (added)

uspace/lib/c/arch/abs32le/include/libarch/faddr.h

@@ -27 +27 @@
  */
 
-/** @addtogroup libabs32le
+/** @addtogroup libcabs32le
  * @{
  */

uspace/lib/c/arch/ppc32/include/libarch/config.h

@@ -27 +27 @@
  */
 
-/** @addtogroup libppc32
+/** @addtogroup libcppc32
  * @{
  */

uspace/lib/c/arch/riscv64/include/libarch/faddr.h

@@ -27 +27 @@
  */
 
-/** @addtogroup libriscv64
+/** @addtogroup libcriscv64
  * @{
  */

uspace/lib/c/generic/libc.c

@@ -27 +27 @@
  */
 
-/** @addtogroup lc Libc
- * @brief HelenOS C library
- * @{
- * @}
- */
-
-/** @addtogroup libc generic
- * @ingroup lc
+/** @addtogroup libc
  * @{
  */

uspace/lib/clui/tinput.c

@@ -25 +25 @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/** @addtogroup libclui
+ * @{
  */
 
@@ -1053 +1057 @@
         }
 }
+
+/**
+ * @}
+ */

uspace/lib/dltest/dltest.c

@@ -28 +28 @@
 
 /** @addtogroup libdltest
- * @brief Dynamic linking test library
  * @{
  */

uspace/lib/dltest/libdltest.h

@@ -28 +28 @@
 
 /** @addtogroup libdltest
- * @brief Dynamic linking test library
  * @{
  */

uspace/lib/drv/generic/dev_iface.c

@@ -28 +28 @@
 
 /**
- * @defgroup libdrv generic device driver support.
- * @brief HelenOS generic device driver support.
+ * @addtogroup libdrv
  * @{
  */

uspace/lib/drv/generic/driver.c

@@ -29 +29 @@
 
 /**
- * @defgroup libdrv generic device driver support.
- * @brief HelenOS generic device driver support.
+ * @addtogroup libdrv
  * @{
  */

uspace/lib/drv/generic/interrupt.c

@@ -28 +28 @@
 
 /**
- * @defgroup libdrv generic device driver support.
- * @brief HelenOS generic device driver support.
+ * @addtogroup libdrv
  * @{
  */