From 40a156aa94454fa2e3c5c8639dd476c06f51b737 Mon Sep 17 00:00:00 2001
From: engelsman <engelsman>
Date: Fri, 19 Sep 2008 20:56:19 +0000
Subject: Simplified the doxygen comment strategy for fl_color_command()

Too many \defgroup, \ingroup and \relatesalso and doxygen gets confused!
Simplified down to a single \relatesalso, and moved the extra function
documentation into the class comments.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6313 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
 documentation/development.dox | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

(limited to 'documentation')

diff --git a/documentation/development.dox b/documentation/development.dox
index 280c87fdf..c869a1040 100644
--- a/documentation/development.dox
+++ b/documentation/development.dox
@@ -91,6 +91,28 @@ From Duncan: (will be removed later, just for now as a reminder)
    we can add it to a functions.dox file that defines a functions group
    and do that for all of the function documentation?)
 
+\b Update: the trick is not to create duplicate entries in a new group, but
+   to move the function information into the doxygen comments for the
+   class, and use the navigation links provided. Simply using \\relatesalso
+   as the first doxygen command in the function's comment puts it in the
+   appropriate place. There is no need to have \\defgroup and \\ingroup as
+   well, and indeed they don't work. So, to summarize:
+\code
+Gizmo.H
+  /## \class Gizmo
+      A gizmo that does everything
+    #/
+  class Gizmo {
+    etc
+  };
+  extern int popup_gizmo(...);
+
+Gizmo.cxx:
+  /## \relatesalso Gizmo
+      Pops up a gizmo dialog with a Gizmo in it
+    #/
+  int popup_gizmo(...);
+\endcode
 
 <H3>Example comment:</H3>
 
-- 
cgit v1.2.3