Fix a bunch of doxygen warnings.

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

src/ChangeLog

@@ -1,3 +1,28 @@
+2003-10-08  Angus Leeming  <leeming@lyx.org>
+
+	Fix doxygen warnings.
+
+	* CutAndPaste.[Ch] (availableSelections). Now returns a const vector.
+	Remove CutAndPaste:: prefix from header file declaration.
+
+	* LColor.h (fill): remove LColor:: prefix from declaration.
+
+	* buffer.C (readParagraph, simpleLinuxDocOnePar, simpleDocBookOnePar):
+	use lyx::depth_type rather than Paragraph::depth_type so that
+	header file and .C file match.
+
+	* converter.h (intToFormat): remove Converters:: prefix from declaration.
+
+	* Spacing.h: \file Spacing.h -> \file src/Spacing.h
+	* aspell.C: \file aspell_local.C -> \file aspell.C
+	* gettext.C: \file gettext.C -> \file src/gettext.C
+	* gettext.h: \file gettext.h -> \file src/gettext.h
+	* lyxfont.C: \file lyxfont.C -> \file src/lyxfont.C
+	* lyxfont.h: \file lyxfont.h -> \file src/lyxfont.h
+	* text.C: \file text.C -> \file src/text.C
+
+	* toc.C: move comment so that doxygen is not confused.
+
 2003-10-07  Angus Leeming  <leeming@lyx.org>
 
 	* factory.C (createInset): InsetExternal::Params -> InsetExternalParams

src/CutAndPaste.C

@@ -49,7 +49,7 @@ CutStack cuts(10);
 } // namespace anon
 
 
-std::vector<string>
+std::vector<string> const
 CutAndPaste::availableSelections(Buffer const & buffer)
 {
 	vector<string> selList;

src/CutAndPaste.h

@@ -30,8 +30,7 @@ class Paragraph;
 namespace CutAndPaste {
 
 ///
-std::vector<std::string>
+std::vector<std::string> const availableSelections(Buffer const & buffer);
-CutAndPaste::availableSelections(Buffer const & buffer);
 
 ///
 PitPosPair cutSelection(BufferParams const & params,

src/LColor.h

@@ -194,11 +194,11 @@ public:
 	void operator=(LColor const &);
 
 	///
-	void LColor::fill(LColor::color c,
+	void fill(LColor::color c,
-			std::string const & lyxname,
+		  std::string const & lyxname,
-			std::string const & x11name = std::string(),
+		  std::string const & x11name = std::string(),
-			std::string const & latexname = std::string(),
+		  std::string const & latexname = std::string(),
-			std::string const & guiname = std::string());
+		  std::string const & guiname = std::string());
 
 	/// set the given LyX color to the color defined by the X11 name given
 	void setColor(LColor::color col, std::string const & x11name);

src/Spacing.h

@@ -1,6 +1,6 @@
 // -*- C++ -*-
 /**
- * \file Spacing.h
+ * \file src/Spacing.h
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *

src/aspell.C

@@ -1,5 +1,5 @@
 /**
- * \file aspell_local.C
+ * \file aspell.C
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *

src/buffer.C

@@ -481,7 +481,7 @@ bool Buffer::readBody(LyXLex & lex, ParagraphList::iterator pit)
 
 int Buffer::readParagraph(LyXLex & lex, string const & token,
 			  ParagraphList & pars, ParagraphList::iterator & pit,
-			  Paragraph::depth_type & depth)
+			  lyx::depth_type & depth)
 {
 	static Change current_change;
 	int unknown = 0;
@@ -1483,7 +1483,7 @@ void reset(PAR_TAG & p1, PAR_TAG const & p2)
 // Handle internal paragraph parsing -- layout already processed.
 void Buffer::simpleLinuxDocOnePar(ostream & os,
 	ParagraphList::iterator par,
-	Paragraph::depth_type /*depth*/) const
+	lyx::depth_type /*depth*/) const
 {
 	LyXLayout_ptr const & style = par->layout();
 
@@ -1953,7 +1953,7 @@ void Buffer::makeDocBookFile(string const & fname, bool nice, bool only_body)
 
 void Buffer::simpleDocBookOnePar(ostream & os,
 				 ParagraphList::iterator par, int & desc_on,
-				 Paragraph::depth_type depth) const
+				 lyx::depth_type depth) const
 {
 	bool emph_flag = false;
 

src/converter.h

@@ -126,7 +126,7 @@ public:
 private:
 	///
 	std::vector<Format const *> const
-	Converters::intToFormat(std::vector<int> const & input);
+	intToFormat(std::vector<int> const & input);
 	///
 	bool scanLog(Buffer const & buffer, std::string const & command,
 		     std::string const & filename);

src/frontends/controllers/ChangeLog

@@ -1,3 +1,9 @@
+2003-10-08  Angus Leeming  <leeming@lyx.org>
+
+	Fix doxygen warnings.
+
+	* frnt_lang.h: move comment so that doxygen is not confused.
+
 2003-10-07  Angus Leeming  <leeming@lyx.org>
 
 	* ControlExternal.[Ch]: InsetExternal::Params -> InsetExternalParams.

src/frontends/controllers/ControlBibtex.C

@@ -23,8 +23,8 @@
 
 using lyx::support::OnlyFilename;
 
-using std::string;
 using std::pair;
+using std::string;
 using std::vector;
 
 

src/frontends/controllers/frnt_lang.h

@@ -7,6 +7,8 @@
  * \author Angus Leeming
  *
  * Full author contact details are available in file CREDITS.
+ *
+ * Ease the use of internationalised language strings in the dialogs.
  */
 
 #ifndef FRNT_LANG_H
@@ -16,8 +18,6 @@
 #include <utility>
 #include <vector>
 
-/** Ease the use of internationalised language strings in the dialogs.
- */
 namespace frnt {
 
 ///

src/frontends/gnome/ChangeLog

@@ -1,3 +1,10 @@
+2003-10-08  Angus Leeming  <leeming@lyx.org>
+
+	Fix doxygen warnings.
+
+	* GView.C: \file GView.C -> \file gnome/GView.C
+	* GView.h: \file GView.h -> \file gnome/GView.h
+
 2003-09-21  Lars Gullik Bjønnes  <larsbj@gullik.net>
 
 	* lyx_gui.C (parse_init): fix new bug

src/frontends/gnome/GView.C

@@ -1,5 +1,5 @@
 /**
- * \file GView.C
+ * \file gnome/GView.C
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *

src/frontends/gnome/GView.h

@@ -1,6 +1,6 @@
 // -*- C++ -*-
 /**
- * \file GView.h
+ * \file gnome/GView.h
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *

src/frontends/gtk/Alert_pimpl.C

@@ -1,5 +1,5 @@
 /**
- * \file Alert_pimpl.C
+ * \file gtk/Alert_pimpl.C
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *

src/frontends/gtk/ChangeLog

@@ -1,3 +1,12 @@
+2003-10-08  Angus Leeming  <leeming@lyx.org>
+
+	Fix doxygen warnings.
+
+	* Alert_pimpl.C: \file Alert_pimpl.C -> \file gtk/Alert_pimpl.C
+	* FileDialog.C: \file FileDialog.C -> \file gtk/FileDialog.C
+	* GView.C: \file GView.C -> \file gtk/GView.C
+	* GView.h: \file GView.h -> \file gtk/GView.h
+
 2003-09-21  Lars Gullik Bjønnes  <larsbj@gullik.net>
 
 	* GToolbar.C (add): Make it take a ToobarBackend::Item as arg,

src/frontends/gtk/FileDialog.C

@@ -1,5 +1,5 @@
 /**
- * \file FileDialog.C
+ * \file gtk/FileDialog.C
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *

src/frontends/gtk/GView.C

@@ -1,5 +1,5 @@
 /**
- * \file GView.C
+ * \file gtk/GView.C
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *

src/frontends/gtk/GView.h

@@ -1,6 +1,6 @@
 // -*- C++ -*-
 /**
- * \file GView.h
+ * \file gtk/GView.h
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *

src/frontends/qt2/ChangeLog

@@ -1,3 +1,9 @@
+2003-10-08  Angus Leeming  <leeming@lyx.org>
+
+	Fix doxygen warnings.
+
+	* QLToolbar.h: \file qt2/Toolbar_pimpl.h -> \file QLToolbar.h
+
 2003-10-07  Angus Leeming  <leeming@lyx.org>
 
 	* ui/QExternalDialogBase.ui:

src/frontends/qt2/QLToolbar.h

@@ -1,6 +1,6 @@
 // -*- C++ -*-
 /**
- * \file qt2/Toolbar_pimpl.h
+ * \file QLToolbar.h
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *

src/gettext.C

@@ -1,5 +1,5 @@
 /**
- * \file gettext.C
+ * \file src/gettext.C
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *

src/gettext.h

@@ -1,6 +1,6 @@
 // -*- C++ -*-
 /**
- * \file gettext.h
+ * \file src/gettext.h
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *

src/insets/ChangeLog

@@ -1,3 +1,10 @@
+2003-10-08  Angus Leeming  <leeming@lyx.org>
+
+	Fix doxygen warnings.
+
+	* insetbox.h (localDispatch): remove prefix InsetBox:: from declaration.
+	* insetnote.h (localDispatch): remove prefix InsetNote:: from declaration.
+
 2003-10-07  Angus Leeming  <leeming@lyx.org>
 
 	* ExternalTransforms.[Ch]: new files, detailing transforms that can

src/insets/insetbox.h

@@ -74,7 +74,7 @@ public:
 	///
 	void setButtonLabel();
 	///
-	dispatch_result InsetBox::localDispatch(FuncRequest const &);
+	dispatch_result localDispatch(FuncRequest const &);
 	///
 	void metrics(MetricsInfo &, Dimension &) const;
 	/// show the Box dialog

src/insets/insetnote.h

@@ -52,7 +52,7 @@ public:
 	///
 	void setButtonLabel();
 	///
-	dispatch_result InsetNote::localDispatch(FuncRequest const &);
+	dispatch_result localDispatch(FuncRequest const &);
 	///
 	void metrics(MetricsInfo &, Dimension &) const;
 	/// show the note dialog

src/lyxfont.C

@@ -1,5 +1,5 @@
 /**
- * \file lyxfont.C
+ * \file src/lyxfont.C
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *

src/lyxfont.h

@@ -1,6 +1,6 @@
 // -*- C++ -*-
 /**
- * \file lyxfont.h
+ * \file src/lyxfont.h
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *

src/support/ChangeLog

@@ -1,3 +1,15 @@
+2003-10-08  Angus Leeming  <leeming@lyx.org>
+
+	* copied_ptr.h: get rid of the swap member function.
+
+2003-10-08  Angus Leeming  <leeming@lyx.org>
+
+	Fix doxygen warnings.
+
+	* debugstream.h: \file debugStream.h -> \file debugstream.h
+
+	* os.h: move comment so that doxygen is not confused.
+
 2003-10-07  Jürgen Spitzmüller <j.spitzmueller@gmx.de>
 
 	* Makefile.am: fix typo.

src/support/copied_ptr.h

@@ -48,7 +48,6 @@ public:
 
 private:
 	T * ptr_;
-	void swap(copied_ptr &);
 };
 
 
@@ -76,7 +75,7 @@ copied_ptr<T, Traits> & copied_ptr<T, Traits>::operator=(copied_ptr const & othe
 {
 	if (&other != this) {
 		copied_ptr temp(other);
-		swap(temp);
+		std::swap(ptr_, temp.ptr_);
 	}
 	return *this;
 }
@@ -102,13 +101,6 @@ T * copied_ptr<T, Traits>::get() const
 	return ptr_;
 }
 
-
-template <typename T, typename Traits>
-void copied_ptr<T, Traits>::swap(copied_ptr & other)
-{
-	std::swap( ptr_, other.ptr_ );
-}
-
 } // namespace support
 } // namespace lyx
 

src/support/debugstream.h

@@ -1,6 +1,6 @@
 // -*- C++ -*-
 /**
- * \file debugStream.h
+ * \file debugstream.h
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *

src/support/os.h

@@ -7,6 +7,8 @@
  * \author Ruurd A. Reitsma
  *
  * Full author contact details are available in file CREDITS.
+ *
+ * wrap OS specific stuff
  */
 
 #ifndef OS_H
@@ -15,7 +17,6 @@
 #include <string>
 
 
-/// wrap OS specific stuff
 namespace lyx {
 namespace support {
 namespace os {

src/tex2lyx/ChangeLog

@@ -1,3 +1,14 @@
+2003-10-08  Angus Leeming  <leeming@lyx.org>
+
+	Fix doxygen warnings.
+
+	* Spacing.h: \file Spacing.h -> \file tex2lyx/Spacing.h
+	* gettext.C: \file gettext.C -> \file tex2lyx/gettext.C
+	* gettext.h: \file gettext.h -> \file tex2lyx/gettext.h
+	* lyxfont.C: \file lyxfont.C -> \file tex2lyx/lyxfont.C
+	* lyxfont.h: \file lyxfont.h -> \file tex2lyx/lyxfont.h
+	* text.C:    \file text.C    -> \file tex2lyx/text.C
+
 2003-09-26  Lars Gullik Bjønnes  <larsbj@gullik.net>
 
 	* tex2lyx.C: adjust for new debugstream.

src/tex2lyx/Spacing.h

@@ -1,6 +1,6 @@
 // -*- C++ -*-
 /**
- * \file Spacing.h
+ * \file tex2lyx/Spacing.h
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *

src/tex2lyx/gettext.C

@@ -1,5 +1,5 @@
 /**
- * \file gettext.C
+ * \file tex2lyx/gettext.C
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *

src/tex2lyx/gettext.h

@@ -1,6 +1,6 @@
 // -*- C++ -*-
 /**
- * \file gettext.h
+ * \file tex2lyx/gettext.h
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *

src/tex2lyx/lyxfont.C

@@ -1,5 +1,5 @@
 /**
- * \file lyxfont.C
+ * \file tex2lyx/lyxfont.C
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *

src/tex2lyx/lyxfont.h

@@ -1,6 +1,6 @@
 // -*- C++ -*-
 /**
- * \file lyxfont.h
+ * \file tex2lyx/lyxfont.h
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *

src/tex2lyx/text.C

@@ -1,5 +1,5 @@
 /**
- * \file text.C
+ * \file tex2lyx/text.C
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *

src/text.C

@@ -1,5 +1,5 @@
 /**
- * \file text.C
+ * \file src/text.C
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *

src/toc.h

@@ -8,6 +8,8 @@
  * \author Angus Leeming
  *
  * Full author contact details are available in file CREDITS.
+ *
+ * Nice functions and objects to handle TOCs
  */
 
 #ifndef TOC_H
@@ -23,8 +25,6 @@ class LyXView;
 class Paragraph;
 class FuncRequest;
 
-/** Nice functions and objects to handle TOCs
- */
 namespace lyx {
 namespace toc {