Move each GTK Widget to its own documentation group

Add compiler warnings to documentation
2019-03-26 21:12:37 +01:00 · 2019-03-26 21:12:05 +01:00
5 changed files with 15 additions and 4 deletions
--- a/doxygen/compilation.dox
+++ b/doxygen/compilation.dox
@ -57,4 +57,11 @@ in order to build the program and

 The subfolder 'AUR' contains a PKGBUILD file to build an Archlinux/Pacman package.

+@subsection Compiler Warnings
+
+The compiler will throw the following warnings. Compiled with GCC 8.2.1.
+
+| Warning | Assessment |
+| ------- | ---------- |
+| warning: ‘calculate_path_miter_points’ defined but not used [-Wunused-function] | Ignore. Function will be used in later versions. |
 */
--- a/include/gds-render/widgets/conv-settings-dialog.h
+++ b/include/gds-render/widgets/conv-settings-dialog.h
@ -24,7 +24,8 @@
 */

 /**
- * @addtogroup Widgets
+ * @addtogroup RendererSettingsDialog
+ * @ingroup Widgets
 * @{
 */

--- a/include/gds-render/widgets/layer-element.h
+++ b/include/gds-render/widgets/layer-element.h
@ -24,7 +24,8 @@
 */

 /**
- * @addtogroup Widgets
+ * @addtogroup LayerElement
+ * @ingroup Widgets
 * @{
 */

--- a/widgets/conv-settings-dialog.c
+++ b/widgets/conv-settings-dialog.c
@ -24,7 +24,8 @@
 */

 /**
- * @addtogroup Widgets
+ * @addtogroup RendererSettingsDialog
+ * @ingroup Widgets
 * @{
 */

--- a/widgets/layer-element.c
+++ b/widgets/layer-element.c
@ -31,7 +31,8 @@
 */

 /**
- * @addtogroup Widgets
+ * @addtogroup LayerElement
+ * @ingroup Widgets
 * @{
 */
Author	SHA1	Message	Date
Mario Hüttel	e278ad6d94	Move each GTK Widget to its own documentation group	2019-03-26 21:12:37 +01:00
Mario Hüttel	8d8af8d211	Add compiler warnings to documentation	2019-03-26 21:12:05 +01:00