doxygen: Remove some stale doxygen references.
authorAndre Noll <maan@tuebingen.mpg.de>
Tue, 16 May 2017 21:09:33 +0000 (23:09 +0200)
committerAndre Noll <maan@tuebingen.mpg.de>
Sun, 25 Jun 2017 18:10:57 +0000 (20:10 +0200)
When we switched to lopsub, the callback request functions became
unused and were removed. At the same time, all command handlers were
made static, so they are no longer part of the doxygen documentation
and we shouldn't refer to them any more.

Also struct slot_info and the server_uptime variable have been made
private to their respective files audiod and time.c. Tthe latter was
in fact replaced by a timeval struct long ago.

The http and udp receivers don't have an init function any more, and
get_chunk_table_of_row() was removed ten years ago in commit 54a480ae.

Most references of the source code documentation will be annotated
with \ref in a subsequent commit to avoid this kind of documentation
bug in the future.

afs.c
aft.c
audiod.c
daemon.c
recv.h

diff --git a/afs.c b/afs.c
index 75b82c2..089b8b6 100644 (file)
--- a/afs.c
+++ b/afs.c
@@ -201,9 +201,8 @@ static int dispatch_result(int result_shmid, callback_result_handler *handler,
  * shmid are passed to that function as an osl object. The private_result_data
  * pointer is passed as the second argument to \a result_handler.
  *
- * \return Number of shared memory areas dispatched on success, negative on errors.
- *
- * \sa send_option_arg_callback_request(), send_standard_callback_request().
+ * \return Number of shared memory areas dispatched on success, negative on
+ * errors.
  */
 int send_callback_request(afs_callback *f, struct osl_object *query,
                callback_result_handler *result_handler,
diff --git a/aft.c b/aft.c
index 4a81244..2d5bbe8 100644 (file)
--- a/aft.c
+++ b/aft.c
@@ -589,8 +589,6 @@ static int get_hash_of_row(const struct osl_row *row, unsigned char **hash)
  * \param afhi Result pointer.
  *
  * \return The return value of the underlying call to osl_get_object().
- *
- * \sa get_chunk_table_of_row().
  */
 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi)
 {
@@ -1907,11 +1905,7 @@ out:
 }
 EXPORT_SERVER_CMD_HANDLER(add);
 
-/**
- * Flags used by the touch command.
- *
- * \sa com_touch().
- */
+/** Flags used by the touch command. */
 enum touch_flags {
        /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
        TOUCH_FLAG_FNM_PATHNAME = 1,
@@ -2397,8 +2391,6 @@ static int check_audio_file(struct osl_row *row, void *data)
  * \param aca Only ->pbout is used for diagnostics.
  *
  * \return Standard. Inconsistencies are reported but not regarded as an error.
- *
- * \sa com_check().
  */
 int aft_check_callback(struct afs_callback_arg *aca)
 {
index 74d0ce2..20902c3 100644 (file)
--- a/audiod.c
+++ b/audiod.c
@@ -109,9 +109,7 @@ struct slot_info {
  * para_audiod uses \p MAX_STREAM_SLOTS different slots, each of which may
  * be associated with a receiver/filter/writer triple. This array holds all
  * information on the status of these slots.
- *
- * \sa struct slot_info
- * */
+ */
 struct slot_info slot[MAX_STREAM_SLOTS];
 
 /** The vss status flags audiod is interested in. */
index 20cdc6a..4e15824 100644 (file)
--- a/daemon.c
+++ b/daemon.c
@@ -374,8 +374,6 @@ time_t daemon_get_uptime(const struct timeval *current_time)
  * \param current_time See a \ref daemon_get_uptime().
  *
  * \return A dynamically allocated string of the form "days:hours:minutes".
- *
- * \sa server_uptime.
  */
 __malloc char *daemon_get_uptime_str(const struct timeval *current_time)
 {
diff --git a/recv.h b/recv.h
index 68978a3..a53781f 100644 (file)
--- a/recv.h
+++ b/recv.h
@@ -47,8 +47,6 @@ struct receiver {
         * The optional receiver init function.
         *
         * Performs any initialization needed before the receiver can be opened.
-        *
-        * \sa http_recv_init udp_recv_init.
         */
        void (*init)(void);
        /**
@@ -60,7 +58,7 @@ struct receiver {
         * guaranteed to point to valid configuration data (as previously
         * obtained from the config parser).
         *
-        * \sa receiver_node::conf, receiver_node::buf.
+        * \sa struct \ref receiver_node.
         */
        int (*open)(struct receiver_node *rn);
        /**