From 69aa257b8391b5c05d5ba70f0587c696347b048a Mon Sep 17 00:00:00 2001
From: Francesco Montorsi <f18m_cpp217828@yahoo.it>
Date: Sun, 20 Dec 2009 14:50:50 +0000
Subject: [PATCH] fix a few doxygen warnings

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@62957 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 interface/wx/ribbon/art.h       | 26 +++++++++++++++-----------
 interface/wx/ribbon/buttonbar.h |  3 +++
 interface/wx/ribbon/gallery.h   |  2 ++
 interface/wx/ribbon/toolbar.h   |  7 ++++---
 4 files changed, 24 insertions(+), 14 deletions(-)

diff --git a/interface/wx/ribbon/art.h b/interface/wx/ribbon/art.h
index bfaa5a1597..c08e5b3cc4 100644
--- a/interface/wx/ribbon/art.h
+++ b/interface/wx/ribbon/art.h
@@ -186,8 +186,8 @@ enum wxRibbonButtonKind
     appearance.
 
     By default, a wxRibbonBar uses an instance of this class called
-    wxRibbonDefaultArtProvider, which resolves to wxRibbonAUIArtProvider,
-    wxRibbonMSWArtProvider, or wxRibbonOSXArtProvider - whichever is most appropriate
+    @c wxRibbonDefaultArtProvider, which resolves to @c wxRibbonAUIArtProvider,
+    @c wxRibbonMSWArtProvider, or @c wxRibbonOSXArtProvider - whichever is most appropriate
     to the current platform. These art providers are all slightly configurable with
     regard to colours and fonts, but for larger modifications, you can derive from
     one of these classes, or write a completely new art provider class.
@@ -265,17 +265,17 @@ public:
         @a id can be one of the colour values of @ref wxRibbonArtSetting, though
         not all colour settings will have an affect on every art provider.
         
-        \see SetColourScheme()
+        @see SetColourScheme()
     */
     virtual void SetColour(int id, const wxColor& colour) = 0;
     
     /**
-        \see wxRibbonArtProvider::GetColour()
+        @see wxRibbonArtProvider::GetColour()
     */
     wxColour GetColor(int id) const;
     
     /**
-        \see wxRibbonArtProvider::SetColour()
+        @see wxRibbonArtProvider::SetColour()
     */
     void SetColor(int id, const wxColour& color);
     
@@ -298,11 +298,11 @@ public:
         values are dependant upon the last values given to SetColourScheme(),
         as described above.
         
-        \param[out] primary
+        @param[out] primary
             Pointer to a location to store the primary colour, or NULL.
-        \param[out] secondary
+        @param[out] secondary
             Pointer to a location to store the secondary colour, or NULL.
-        \param[out] tertiary
+        @param[out] tertiary
             Pointer to a location to store the tertiary colour, or NULL.
     */
     virtual void GetColourScheme(wxColour* primary,
@@ -318,8 +318,8 @@ public:
         Note that some art providers may not use the tertiary colour for
         anything, and some may not use the secondary colour either.
         
-        \see SetColour()
-        \see GetColourScheme()
+        @see SetColour()
+        @see GetColourScheme()
     */    
     virtual void SetColourScheme(const wxColour& primary,
                         const wxColour& secondary,
@@ -899,7 +899,11 @@ public:
             The ribbon panel in question. Attributes like the panel label can
             be queried from this.
         @param[out] desired_bitmap_size
-            
+            Optional parameter which is filled with the size of the bitmap
+            suitable for a minimised ribbon panel.
+        @param[out] expanded_panel_direction
+            Optional parameter which is filled with the direction of the
+            minimised panel (@c wxEAST or @c wxSOUTH depending on the style).
     */
     virtual wxSize GetMinimisedPanelMinimumSize(
                         wxDC& dc,
diff --git a/interface/wx/ribbon/buttonbar.h b/interface/wx/ribbon/buttonbar.h
index 2b5ed45e4d..c209cf7146 100644
--- a/interface/wx/ribbon/buttonbar.h
+++ b/interface/wx/ribbon/buttonbar.h
@@ -124,8 +124,11 @@ public:
 
     /**
         Construct a ribbon button bar with the given parameters.
+        
         @param parent
             Parent window for the button bar (typically a wxRibbonPanel).
+        @param id
+            An identifier for the button bar. @c wxID_ANY is taken to mean a default.
         @param pos
             Initial position of the button bar.
         @param size
diff --git a/interface/wx/ribbon/gallery.h b/interface/wx/ribbon/gallery.h
index c7b99e4b60..27d2fe349e 100644
--- a/interface/wx/ribbon/gallery.h
+++ b/interface/wx/ribbon/gallery.h
@@ -58,6 +58,8 @@ public:
         Construct a ribbon gallery with the given parameters.
         @param parent
             Parent window for the gallery (typically a wxRibbonPanel).
+        @param id
+            An identifier for the gallery. @c wxID_ANY is taken to mean a default.
         @param pos
             Initial position of the gallery.
         @param size
diff --git a/interface/wx/ribbon/toolbar.h b/interface/wx/ribbon/toolbar.h
index 66ea8ec1bf..0e397cc5f3 100644
--- a/interface/wx/ribbon/toolbar.h
+++ b/interface/wx/ribbon/toolbar.h
@@ -39,8 +39,11 @@ public:
 
     /**
         Construct a ribbon tool bar with the given parameters.
+        
         @param parent
             Parent window for the tool bar (typically a wxRibbonPanel).
+        @param id
+            An identifier for the toolbar. @c wxID_ANY is taken to mean a default.
         @param pos
             Initial position of the tool bar.
         @param size
@@ -121,9 +124,7 @@ public:
         @return An opaque pointer which can be used only with other tool bar
             methods.
             
-        @see AddDropdownTool()
-        @see AddHybridTool()
-        @saa AddSeparator()
+        @see AddDropdownTool(), AddHybridTool(), AddSeparator()
     */
     virtual wxRibbonToolBarToolBase* AddTool(
                 int tool_id,
-- 
2.45.2