Doxygen fixes.

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

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.
 

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() {}

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();
 	///

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();
 	///

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;
 };
 

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();
 	///

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() {}

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() {}

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)
+{}

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 &);