From 2353291b370af7c19b570fd256ce4e60bb92a627 Mon Sep 17 00:00:00 2001 From: Angus Leeming Date: Thu, 17 Jul 2003 15:35:42 +0000 Subject: [PATCH] Doxygen fixes. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@7308 a592a061-630c-0410-9148-cb99ea01b6c8 --- src/frontends/controllers/ChangeLog | 15 ++++++++++- src/frontends/controllers/ControlChanges.h | 2 +- src/frontends/controllers/ControlErrorList.h | 2 +- src/frontends/controllers/ControlLog.h | 2 +- src/frontends/controllers/ControlMath.h | 7 +++-- src/frontends/controllers/ControlShowFile.h | 2 +- src/frontends/controllers/ControlTexinfo.h | 2 +- src/frontends/controllers/ControlVCLog.h | 2 +- src/frontends/controllers/Dialog.C | 28 +++++++++++--------- src/frontends/controllers/Dialog.h | 2 +- 10 files changed, 42 insertions(+), 22 deletions(-) diff --git a/src/frontends/controllers/ChangeLog b/src/frontends/controllers/ChangeLog index 6d1d88d3c1..b216c4de47 100644 --- a/src/frontends/controllers/ChangeLog +++ b/src/frontends/controllers/ChangeLog @@ -1,4 +1,17 @@ -2003-07-16 Angus Leeming +2003-07-17 Angus Leeming + + * 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 * 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 3674a5439d..9acfb7a094 100644 --- 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 3ed18213d9..07b30cbf31 100644 --- 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 aec1f362c5..e1bbbf8cef 100644 --- 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 79621ea684..615298b9a5 100644 --- 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 654dc93f36..1a971e4141 100644 --- 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 939493ee84..073571181d 100644 --- 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 ba7ffb3237..a994cda497 100644 --- 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 3530ca4a48..76610286ed 100644 --- 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 ca2a3df940..cae33a6043 100644 --- 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 &); -- 2.39.2