Doxygen fixes.

git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@7308 a592a061-630c-0410-9148-cb99ea01b6c8

diff --git a/src/frontends/controllers/ChangeLog b/src/frontends/controllers/ChangeLog
index 6d1d88d3c1e6febbd2ef41d6fcf201264dd26773..b216c4de479051c29a465ac50b09fa380140cf35 100644 (file)
--- a/src/frontends/controllers/ChangeLog
+++ b/src/frontends/controllers/ChangeLog
@@ -1,4 +1,17 @@
-2003-07-16  Angus Leeming  <angus@localhost.localdomain>
+2003-07-17  Angus Leeming  <leeming@lyx.org>
+
+       * ControlChanges.h:
+       * ControlErrorList.h:
+       * ControlLog.h:
+       * ControlMath.h:
+       * ControlShowFile.h:
+       * ControlTexinfo.h:
+       * ControlVCLog.h:
+       * Dialog.h: fix some doxygen warnings.
+
+       * Dialog.C: shuffle a couple of functions around.
+
+2003-07-16  Angus Leeming  <leeming@lyx.org>
 
        * ControlMath.C (find_xpm): rewrite to make Lars happy by using find_if.
 

diff --git a/src/frontends/controllers/ControlChanges.h b/src/frontends/controllers/ControlChanges.h
index 3674a5439d9040c63c0dfc16b8d4766a9764ba72..9acfb7a094a7fc7d6cf2b4b75895e18f377639ff 100644 (file)
--- a/src/frontends/controllers/ControlChanges.h
+++ b/src/frontends/controllers/ControlChanges.h
@@ -21,7 +21,7 @@ class ControlChanges : public Dialog::Controller {
 public:
        ///
        ControlChanges(Dialog &);
-       ///
+       /// Nothing to initialise in this case.
        virtual bool initialiseParams(string const &) { return true; }
        ///
        virtual void clearParams() {}

diff --git a/src/frontends/controllers/ControlErrorList.h b/src/frontends/controllers/ControlErrorList.h
index 3ed18213d9a2300316fe9c5a85784707f8eb3900..07b30cbf31a7c2cd2bc35a7e17a8959923d062a9 100644 (file)
--- a/src/frontends/controllers/ControlErrorList.h
+++ b/src/frontends/controllers/ControlErrorList.h
@@ -29,7 +29,7 @@ public:
        ///
        virtual bool isBufferDependent() const { return true; }
        ///
-       virtual bool initialiseParams(string const & params);
+       virtual bool initialiseParams(string const & data);
        ///
        virtual void clearParams();
        ///

diff --git a/src/frontends/controllers/ControlLog.h b/src/frontends/controllers/ControlLog.h
index aec1f362c5ed38e7c596dc6c30c9a8d2364835e0..e1bbbf8cef15b0c572f830c8778b90c9fa543e6b 100644 (file)
--- a/src/frontends/controllers/ControlLog.h
+++ b/src/frontends/controllers/ControlLog.h
@@ -25,7 +25,7 @@ public:
        ///
        ControlLog(Dialog &);
        ///
-       virtual bool initialiseParams(string const &);
+       virtual bool initialiseParams(string const & data);
        ///
        virtual void clearParams();
        ///

diff --git a/src/frontends/controllers/ControlMath.h b/src/frontends/controllers/ControlMath.h
index 79621ea684c54fc7cf9a4f4804d6deb856bb7378..615298b9a52369c69d0322d2f1b70c20dff7263a 100644 (file)
--- a/src/frontends/controllers/ControlMath.h
+++ b/src/frontends/controllers/ControlMath.h
@@ -23,6 +23,7 @@ class ControlMath : public Dialog::Controller {
 public:
        ControlMath(Dialog &);
 
+       /// Nothing to initialise in this case.
        virtual bool initialiseParams(string const &) { return true; }
        virtual void clearParams() {}
        virtual void dispatchParams() {}
@@ -42,9 +43,11 @@ public:
        void dispatchMatrix(string const & str) const;
        /// Insert a delimiter
        void dispatchDelim(string const & str) const;
-       /// switch between display and inline
+       /// Wwitch between display and inline
        void dispatchToggleDisplay() const;
-       /// a request to launch dialog \param name.
+       /** A request to the kernel to launch a dialog.
+        *  \param name the dialog identifier.
+        */
        void showDialog(string const & name) const;
 };
 

diff --git a/src/frontends/controllers/ControlShowFile.h b/src/frontends/controllers/ControlShowFile.h
index 654dc93f36973efca7b650f1e511746c08f25d82..1a971e4141e6bf000be7b418b8b3adeacf365790 100644 (file)
--- a/src/frontends/controllers/ControlShowFile.h
+++ b/src/frontends/controllers/ControlShowFile.h
@@ -21,7 +21,7 @@ public:
        ///
        ControlShowFile(Dialog &);
        ///
-       virtual bool initialiseParams(string const &);
+       virtual bool initialiseParams(string const & data);
        ///
        virtual void clearParams();
        ///

diff --git a/src/frontends/controllers/ControlTexinfo.h b/src/frontends/controllers/ControlTexinfo.h
index 939493ee849c002be0655360d9c20b63f741e01f..073571181d912029d7e60a9d53179dc9cc8182c4 100644 (file)
--- a/src/frontends/controllers/ControlTexinfo.h
+++ b/src/frontends/controllers/ControlTexinfo.h
@@ -22,7 +22,7 @@ class ControlTexinfo : public Dialog::Controller {
 public:
        ///
        ControlTexinfo(Dialog &);
-       ///
+       /// Nothing to initialise in this case.
        virtual bool initialiseParams(string const &) { return true; }
        ///
        virtual void clearParams() {}

diff --git a/src/frontends/controllers/ControlVCLog.h b/src/frontends/controllers/ControlVCLog.h
index ba7ffb32374739561f273d6b86ad537ce9e31d50..a994cda497e269b792be84c6eb8aa1ba7ffde8a0 100644 (file)
--- a/src/frontends/controllers/ControlVCLog.h
+++ b/src/frontends/controllers/ControlVCLog.h
@@ -19,7 +19,7 @@ class ControlVCLog : public Dialog::Controller {
 public:
        ///
        ControlVCLog(Dialog &);
-       ///
+       /// Nothing to initialise in this case.
        virtual bool initialiseParams(string const &) { return true; }
        ///
        virtual void clearParams() {}

diff --git a/src/frontends/controllers/Dialog.C b/src/frontends/controllers/Dialog.C
index 3530ca4a484860f44e10a0386704679dc7e1a143..76610286ede0be8de0d1aa9eba46a8a2eb0e6b55 100644 (file)
--- a/src/frontends/controllers/Dialog.C
+++ b/src/frontends/controllers/Dialog.C
@@ -149,6 +149,20 @@ ButtonController & Dialog::bc() const
 }
 
 
+void Dialog::setController(Controller * i)
+{
+       Assert(i && !controller_ptr_.get());
+       controller_ptr_.reset(i);
+}
+
+
+void Dialog::setView(View * v)
+{
+       Assert(v && !view_ptr_.get());
+       view_ptr_.reset(v);
+}
+
+
 Dialog::Controller::Controller(Dialog & parent)
        : parent_(parent)
 {}
@@ -185,15 +199,5 @@ string const & Dialog::View::getTitle() const
 }
 
 
-void Dialog::setController(Controller * i)
-{
-       Assert(i && !controller_ptr_.get());
-       controller_ptr_.reset(i);
-}
-
-
-void Dialog::setView(View * v)
-{
-       Assert(v && !view_ptr_.get());
-       view_ptr_.reset(v);
-}
+void Dialog::View::partialUpdate(int)
+{}

diff --git a/src/frontends/controllers/Dialog.h b/src/frontends/controllers/Dialog.h
index ca2a3df940ca83b45c89170bfa0062f4d5a17ce1..cae33a60434fad3cd3edd70adfba0205ab4c4901 100644 (file)
--- a/src/frontends/controllers/Dialog.h
+++ b/src/frontends/controllers/Dialog.h
@@ -221,7 +221,7 @@ public:
         *  dialog therefore needs updating.
         *  \param id identifies what should be updated.
         */
-       virtual void partialUpdate(int /* id */) {}
+       virtual void partialUpdate(int id);
 
        /// sets the title of the dialog (window caption)
        void setTitle(string const &);