]> git.lyx.org Git - features.git/commitdiff
Fix a bunch of doxygen warnings.
authorAngus Leeming <leeming@lyx.org>
Wed, 8 Oct 2003 11:31:51 +0000 (11:31 +0000)
committerAngus Leeming <leeming@lyx.org>
Wed, 8 Oct 2003 11:31:51 +0000 (11:31 +0000)
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@7879 a592a061-630c-0410-9148-cb99ea01b6c8

41 files changed:
src/ChangeLog
src/CutAndPaste.C
src/CutAndPaste.h
src/LColor.h
src/Spacing.h
src/aspell.C
src/buffer.C
src/converter.h
src/frontends/controllers/ChangeLog
src/frontends/controllers/ControlBibtex.C
src/frontends/controllers/frnt_lang.h
src/frontends/gnome/ChangeLog
src/frontends/gnome/GView.C
src/frontends/gnome/GView.h
src/frontends/gtk/Alert_pimpl.C
src/frontends/gtk/ChangeLog
src/frontends/gtk/FileDialog.C
src/frontends/gtk/GView.C
src/frontends/gtk/GView.h
src/frontends/qt2/ChangeLog
src/frontends/qt2/QLToolbar.h
src/gettext.C
src/gettext.h
src/insets/ChangeLog
src/insets/insetbox.h
src/insets/insetnote.h
src/lyxfont.C
src/lyxfont.h
src/support/ChangeLog
src/support/copied_ptr.h
src/support/debugstream.h
src/support/os.h
src/tex2lyx/ChangeLog
src/tex2lyx/Spacing.h
src/tex2lyx/gettext.C
src/tex2lyx/gettext.h
src/tex2lyx/lyxfont.C
src/tex2lyx/lyxfont.h
src/tex2lyx/text.C
src/text.C
src/toc.h

index 2af780c6c0b2230b9c16bafa5950805485109d04..258543c59c4d2494c816100d70f84e8809c331a2 100644 (file)
@@ -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
index a1205d72a49aa6c72dd5b21a61a69cea3d8d804d..776600b22b2fff61cf302019fca5587c75e52010 100644 (file)
@@ -49,7 +49,7 @@ CutStack cuts(10);
 } // namespace anon
 
 
-std::vector<string>
+std::vector<string> const
 CutAndPaste::availableSelections(Buffer const & buffer)
 {
        vector<string> selList;
index 7d2e4a1a853928f9083d73ea65097a33e83bcefb..0c753fbadc28758764f9b268cf10f47afb56c1fe 100644 (file)
@@ -30,8 +30,7 @@ class Paragraph;
 namespace CutAndPaste {
 
 ///
-std::vector<std::string>
-CutAndPaste::availableSelections(Buffer const & buffer);
+std::vector<std::string> const availableSelections(Buffer const & buffer);
 
 ///
 PitPosPair cutSelection(BufferParams const & params,
index 794133b6145d0baeaebb807945a5ca1cb743b30a..40c656db88c65fe42582df6c5fbf49f94a96facc 100644 (file)
@@ -194,11 +194,11 @@ public:
        void operator=(LColor const &);
 
        ///
-       void LColor::fill(LColor::color c,
-                       std::string const & lyxname,
-                       std::string const & x11name = std::string(),
-                       std::string const & latexname = std::string(),
-                       std::string const & guiname = std::string());
+       void fill(LColor::color c,
+                 std::string const & lyxname,
+                 std::string const & x11name = std::string(),
+                 std::string const & latexname = 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);
index 4d25b3fd9684d8872bf44ed32b1a2d271892fbbb..03c5db72318e79b7c6329a289d35bcc5d12516f8 100644 (file)
@@ -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.
  *
index b0470339b747e2b303639f0ce69c6efc01c64f8b..4541ea01eba6576bda65f1153d75758b4130dd9a 100644 (file)
@@ -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.
  *
index 6bf7ac231f538200a3bb28d506fea6fc4d3d8a00..d3c34619e572975e8c74b30c94222d6f20c34b50 100644 (file)
@@ -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;
 
index 6c0930a39863e415b44e4cdbe3859c580059b51c..a244198e8bee46b7daff7a1b4e47737b6d342779 100644 (file)
@@ -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);
index 242c3fe6bdef9ef65c701c16a44faae60ae31ff3..152a2e64d0fb66a207015d8de19dfb79e2ed8fac 100644 (file)
@@ -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.
index db0b95260fc3ec1370b8ade65b682c9c1b4cc5f2..d513c375046b8f148ff9286fc354039f0837d4eb 100644 (file)
@@ -23,8 +23,8 @@
 
 using lyx::support::OnlyFilename;
 
-using std::string;
 using std::pair;
+using std::string;
 using std::vector;
 
 
index 6d2c3e53b71e37ad524025acebc1b17b7411b353..de12944b9b90faef0bfdbc85a69f1a1047d91932 100644 (file)
@@ -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 {
 
 ///
index 8af496f70ac80f2929a8bb5830ab67d32a488c0b..7081efa7091bcec328b309b8c7ceec0304f8b3d4 100644 (file)
@@ -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
index b2f3efc780178f1645ebcabdc86b438e9673ed81..387c82583e5e9e22e44e2f3a9b6904cd93933bf0 100644 (file)
@@ -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.
  *
index 8609271901caa6e6b9525aa0c62f17c91ee3e1d4..966a816bced574e74e9fc94f92191239be0c6a2a 100644 (file)
@@ -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.
  *
index dfec643dd6f0bb710d2d761bb0d6a62b9b5977ec..fd69a46ac64314c8ddaa4bf35865c65ff08f9566 100644 (file)
@@ -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.
  *
index ca1487fecb4faac4065b76830eb0cb6f09d78491..30958b4d1257153ab87e234a66358d74c38b2dc2 100644 (file)
@@ -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,
index af3cb9e191120b9089f16d8199e7e9cf8f1a8814..a0338656eedec48e9041ac65c63f0f3c48ab7d6d 100644 (file)
@@ -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.
  *
index e71763757cda0be59d645ed95003c69d319b1beb..aed312b427570176ae893c8b356f48126dac8659 100644 (file)
@@ -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.
  *
index 9bfb989045462d1332152dc0bbdb1baa54d6a3b6..039532bca571357c79baf6372f8fb7332fede6c2 100644 (file)
@@ -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.
  *
index 5d060b1b845e561424f15e30f416514828116e6e..f1e2a158ac688c448cbb0ad73a63e4bf11fbb3aa 100644 (file)
@@ -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:
index 3f5f667975afb86c2471b88ad5d45f5b3a2db81f..85b2fef20b7dba3a4bcfbc9a04bfc545fb24de3d 100644 (file)
@@ -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.
  *
index 9e48e11d0a77d46f8b181dae463dd7f82ae92ca0..2f08de503833626e30be66e33c614ec3cd3fe1d3 100644 (file)
@@ -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.
  *
index a53042c1006e2d21765b4c34bd93ef758ab170a1..7cb097af487d089f9b1170f9c0854dfec5e85c6b 100644 (file)
@@ -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.
  *
index 101474270ed985903274f1d984c377bb089e0fa3..46775fe0fb9f92b7d48b714c2bb767a20a480340 100644 (file)
@@ -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
index 48dbcf23669ab92892a480a6d589a9d3035f8cab..c632653ad8d6d01555ae316cf3dd23ee9f2b58d5 100644 (file)
@@ -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
index dc2a0336c964dd16b3b6f4377f613fd48d70a7b3..8b93cf078606c151e4b6ddecb176096f5176721f 100644 (file)
@@ -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
index 2c3b3c25d2fec7853e04137e726b6448823503a5..fc79dc34d085a0d281e5b80fa9b243603237bda9 100644 (file)
@@ -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.
  *
index 3df9cbe2dbd7be98e6f854c84ff1613bba31bea8..ab683b4e1c33fa32b7862b45d93e814c05f97096 100644 (file)
@@ -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.
  *
index d89e3f3a00d54362b5684c65cf8a48045cca2558..1ba3b17ad7b2585a7dd0a4f0cf22ba4e31175730 100644 (file)
@@ -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.
index 1bf94d349abf8453517a20f52cc0918d8790c532..15ef7551e3be0356e273b093941c7690b9df815c 100644 (file)
@@ -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
 
index 9619720f6b49f1d46a06fe5798735f7f62adfb70..9340def08cab32f1b50847f891a8156efa94906f 100644 (file)
@@ -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.
  *
index 92623a7ac647f9a08ab85ffc8d10a71b5bf825ac..7f1be08a3877dad6cf760e4dd43bd790a8797b62 100644 (file)
@@ -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 {
index cf9c71491b21166cb0e57238bf7668ed7e07c389..545f64fb7a809982501dc3293d127f4986d6deff 100644 (file)
@@ -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.
index fb25d35f501fe426cfe0a2fcb308bf59a9d76314..cf1faa59a2f91cc43dc5b13a5b216f34c200535d 100644 (file)
@@ -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.
  *
index 4003355c0193882ae5dfe181a270f601e759fb11..f2824133c654a800ec96cb732e892d13ce741737 100644 (file)
@@ -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.
  *
index f27f9fdc14f6f0bdb44c05f483144b54803889f0..2b5c8ce3efe523215b59af8646e280872c69b0ea 100644 (file)
@@ -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.
  *
index 713d9170b56baa402f220c3408564e786d99fc9b..0b9f16d93cab438da924fd68a375ddde99031665 100644 (file)
@@ -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.
  *
index 0ff613a829bad91a2ac5ed5ad889bc2bfbeee26c..23e49b51b3cf84c0e0b17dc06de39e1a773857f3 100644 (file)
@@ -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.
  *
index 76e41b055ec25a4325e3f32af316d2cbcb0ff513..b716a5f93b2f0cf8fdc1772934fadc8c7e9d2f55 100644 (file)
@@ -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.
  *
index 3139a74aab3648d4904a86997c088a59aba00613..acbbf7acbf881fbb78ee88286ae6aebdf7f460c3 100644 (file)
@@ -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.
  *
index bb3e8692856368c9d1c473a8918d7dd10dd549ca..a267a87dbeaeb8a6d634a3832de8ad4150c40bd9 100644 (file)
--- a/src/toc.h
+++ b/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 {