diff options
| author | Loek Le Blansch <loek@pipeframe.xyz> | 2024-06-24 08:31:35 +0200 |
|---|---|---|
| committer | Loek Le Blansch <loek@pipeframe.xyz> | 2024-06-24 08:31:35 +0200 |
| commit | 2528775b34f9c0033027931385a4de866ab2749d (patch) | |
| tree | 70d4ac864c7a3d94a6ecd76530f319fe040dfccf /client | |
| parent | e5b2754593bc93987e93a4171b1bcd361b2f1eb6 (diff) | |
add more documentation
Diffstat (limited to 'client')
| -rw-r--r-- | client/cmd.h | 7 | ||||
| -rw-r--r-- | client/i2c.h | 2 | ||||
| -rw-r--r-- | client/parse.h | 4 | ||||
| -rw-r--r-- | client/sock.h | 2 |
4 files changed, 10 insertions, 5 deletions
diff --git a/client/cmd.h b/client/cmd.h index a3cc44a..4f77d50 100644 --- a/client/cmd.h +++ b/client/cmd.h @@ -2,8 +2,13 @@ /** * \ingroup pbc - * \defgroup pbc_cmd cmd + * \defgroup pbc_cmd Commands * \brief Commands within \ref pbc + * + * \note A manpage is available containing end-user usage instructions inside + * the \ref client folder in the source code repository. This page contains the + * internal code documentation for the commands defined in \c pbc. + * * \{ */ diff --git a/client/i2c.h b/client/i2c.h index 87f33c9..d2cfa9a 100644 --- a/client/i2c.h +++ b/client/i2c.h @@ -5,7 +5,7 @@ /** * \ingroup pbc - * \defgroup pbc_i2c i2c + * \defgroup pbc_i2c I2C * \brief I2C abstraction functions * \{ */ diff --git a/client/parse.h b/client/parse.h index 8b7d235..1beb714 100644 --- a/client/parse.h +++ b/client/parse.h @@ -4,8 +4,8 @@ /** * \ingroup pbc - * \defgroup pbc_parse parse - * \brief Debug send command parser utilities + * \defgroup pbc_parse Parse + * \brief Debug \c send command parser utilities * \{ */ diff --git a/client/sock.h b/client/sock.h index c124e45..792123e 100644 --- a/client/sock.h +++ b/client/sock.h @@ -5,7 +5,7 @@ /** * \ingroup pbc - * \defgroup pbc_sock sock + * \defgroup pbc_sock Socket * \brief TCP socket handling * \{ */ |