From 13324bd7410db037c9b098bd3d16280e1a4e2ed5 Mon Sep 17 00:00:00 2001
From: Marek Vavrusa <marek.vavrusa@nic.cz>
Date: Fri, 17 Aug 2012 11:49:50 +0200
Subject: [PATCH] Update Doxygen source list and some documentation-related
bugfixes.
---
Doxyfile | 8 ++++++--
src/common/crc.h | 2 ++
src/common/fdset.h | 2 +-
src/common/heap.h | 2 ++
src/common/prng.h | 2 ++
src/common/slab/slab.c | 2 +-
src/knot/server/journal.h | 2 ++
src/knot/zone/semantic-check.h | 2 ++
src/libknot/util/descriptor.c | 2 ++
src/libknot/util/tolower.h | 2 ++
src/libknot/zone/zone.h | 2 +-
src/zcompile/parser-descriptor.c | 1 +
src/zcompile/parser-util.c | 1 +
13 files changed, 25 insertions(+), 5 deletions(-)
diff --git a/Doxyfile b/Doxyfile
index 6a5a022910..1a5bb0a1e8 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -591,7 +591,11 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = src/ \
+INPUT = src/common \
+ src/libknot \
+ src/common \
+ src/knot \
+ src/zcompile \
Doxy.page.h
# This tag can be used to specify the character encoding of the source files
@@ -622,7 +626,7 @@ RECURSIVE = YES
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
-EXCLUDE =
+EXCLUDE =
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded
diff --git a/src/common/crc.h b/src/common/crc.h
index cf2e1236a8..7d748bee53 100644
--- a/src/common/crc.h
+++ b/src/common/crc.h
@@ -77,3 +77,5 @@ static inline crc_t crc_finalize(crc_t crc)
#endif /* __CRC_H__ */
+
+/*! @} */
diff --git a/src/common/fdset.h b/src/common/fdset.h
index 4fbd9bcfec..4038083aaf 100644
--- a/src/common/fdset.h
+++ b/src/common/fdset.h
@@ -74,7 +74,7 @@ typedef struct fdset_it_t {
/*!
* \brief File descriptor set implementation backend.
- * \notice Functions documentation following.
+ * \note Functions documentation following.
* \internal
*/
struct fdset_backend_t
diff --git a/src/common/heap.h b/src/common/heap.h
index e38ab1ed76..d6f8a0be87 100644
--- a/src/common/heap.h
+++ b/src/common/heap.h
@@ -53,3 +53,5 @@ void heap_delete(struct heap *, int);
#endif /* _HEAP_H_ */
+
+/*! @} */
diff --git a/src/common/prng.h b/src/common/prng.h
index 9f17a780d9..a64eabbf43 100644
--- a/src/common/prng.h
+++ b/src/common/prng.h
@@ -39,3 +39,5 @@
double tls_rand();
#endif //_KNOTD_ACL_H_
+
+/*! @} */
diff --git a/src/common/slab/slab.c b/src/common/slab/slab.c
index df30998938..9a3e8de54e 100644
--- a/src/common/slab/slab.c
+++ b/src/common/slab/slab.c
@@ -231,7 +231,7 @@ void __attribute__ ((destructor)) slab_deinit()
* Cache helper functions.
*/
-/* \notice Not used right now.
+/* \note Not used right now.
static void slab_dump(slab_t* slab) {
printf("%s: buffers (bufsize=%zuB, %u/%u free): \n",
diff --git a/src/knot/server/journal.h b/src/knot/server/journal.h
index 322e25df6e..fd0e3a6895 100644
--- a/src/knot/server/journal.h
+++ b/src/knot/server/journal.h
@@ -359,3 +359,5 @@ void journal_release(journal_t *journal);
int journal_update_crc(int fd);
#endif /* _KNOTD_JOURNAL_H_ */
+
+/*! @} */
diff --git a/src/knot/zone/semantic-check.h b/src/knot/zone/semantic-check.h
index b4de93452d..2f6dad79f9 100644
--- a/src/knot/zone/semantic-check.h
+++ b/src/knot/zone/semantic-check.h
@@ -200,3 +200,5 @@ int zone_do_sem_checks(knot_zone_contents_t *zone, char do_checks,
knot_node_t **last_node);
#endif // _KNOT_SEMANTIC_CHECK_H_
+
+/*! @} */
diff --git a/src/libknot/util/descriptor.c b/src/libknot/util/descriptor.c
index 63e1747061..35ae77ed2c 100644
--- a/src/libknot/util/descriptor.c
+++ b/src/libknot/util/descriptor.c
@@ -569,3 +569,5 @@ int knot_rrtype_is_metatype(uint16_t type)
|| type == KNOT_RRTYPE_OPT);
}
+/*! @} */
+
diff --git a/src/libknot/util/tolower.h b/src/libknot/util/tolower.h
index 6b9e98c5a3..2e922581ad 100644
--- a/src/libknot/util/tolower.h
+++ b/src/libknot/util/tolower.h
@@ -55,3 +55,5 @@ static inline uint8_t knot_tolower(uint8_t c) {
}
#endif /* _KNOT_TOLOWER_H_ */
+
+/*! @} */
diff --git a/src/libknot/zone/zone.h b/src/libknot/zone/zone.h
index 68ff90dc05..31ff2ac40a 100644
--- a/src/libknot/zone/zone.h
+++ b/src/libknot/zone/zone.h
@@ -93,7 +93,7 @@ typedef struct knot_zone knot_zone_t;
/*!
* \brief Creates new empty DNS zone.
*
- * \notice Zone will be created without contents.
+ * \note Zone will be created without contents.
*
* \param name Zone owner.
*
diff --git a/src/zcompile/parser-descriptor.c b/src/zcompile/parser-descriptor.c
index b876877e47..bc3ee1661b 100644
--- a/src/zcompile/parser-descriptor.c
+++ b/src/zcompile/parser-descriptor.c
@@ -539,3 +539,4 @@ uint16_t parser_rrclass_from_string(const char *name)
return (uint16_t) rrclass;
}
+/*! @} */
diff --git a/src/zcompile/parser-util.c b/src/zcompile/parser-util.c
index cfbc624af0..691ac3a377 100644
--- a/src/zcompile/parser-util.c
+++ b/src/zcompile/parser-util.c
@@ -2473,3 +2473,4 @@ void set_bitnsec(uint8_t bits[NSEC_WINDOW_COUNT][NSEC_WINDOW_BITS_SIZE],
bits[window][bit / 8] |= (1 << (7 - bit % 8));
}
+/*! @} */
--
GitLab