From 627f2c70fa6d5c75ef4dfe4e7252adc7c141e6f4 Mon Sep 17 00:00:00 2001 From: Angus Leeming Date: Wed, 8 Oct 2003 11:31:51 +0000 Subject: [PATCH] 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 | 25 +++++++++++++++++++++++ src/CutAndPaste.C | 2 +- src/CutAndPaste.h | 3 +-- src/LColor.h | 10 ++++----- src/Spacing.h | 2 +- src/aspell.C | 2 +- src/buffer.C | 6 +++--- src/converter.h | 2 +- src/frontends/controllers/ChangeLog | 6 ++++++ src/frontends/controllers/ControlBibtex.C | 2 +- src/frontends/controllers/frnt_lang.h | 4 ++-- src/frontends/gnome/ChangeLog | 7 +++++++ src/frontends/gnome/GView.C | 2 +- src/frontends/gnome/GView.h | 2 +- src/frontends/gtk/Alert_pimpl.C | 2 +- src/frontends/gtk/ChangeLog | 9 ++++++++ src/frontends/gtk/FileDialog.C | 2 +- src/frontends/gtk/GView.C | 2 +- src/frontends/gtk/GView.h | 2 +- src/frontends/qt2/ChangeLog | 6 ++++++ src/frontends/qt2/QLToolbar.h | 2 +- src/gettext.C | 2 +- src/gettext.h | 2 +- src/insets/ChangeLog | 7 +++++++ src/insets/insetbox.h | 2 +- src/insets/insetnote.h | 2 +- src/lyxfont.C | 2 +- src/lyxfont.h | 2 +- src/support/ChangeLog | 12 +++++++++++ src/support/copied_ptr.h | 10 +-------- src/support/debugstream.h | 2 +- src/support/os.h | 3 ++- src/tex2lyx/ChangeLog | 11 ++++++++++ src/tex2lyx/Spacing.h | 2 +- src/tex2lyx/gettext.C | 2 +- src/tex2lyx/gettext.h | 2 +- src/tex2lyx/lyxfont.C | 2 +- src/tex2lyx/lyxfont.h | 2 +- src/tex2lyx/text.C | 2 +- src/text.C | 2 +- src/toc.h | 4 ++-- 41 files changed, 125 insertions(+), 50 deletions(-) diff --git a/src/ChangeLog b/src/ChangeLog index 2af780c6c0..258543c59c 100644 --- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,28 @@ +2003-10-08 Angus Leeming + + 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 * factory.C (createInset): InsetExternal::Params -> InsetExternalParams diff --git a/src/CutAndPaste.C b/src/CutAndPaste.C index a1205d72a4..776600b22b 100644 --- a/src/CutAndPaste.C +++ b/src/CutAndPaste.C @@ -49,7 +49,7 @@ CutStack cuts(10); } // namespace anon -std::vector +std::vector const CutAndPaste::availableSelections(Buffer const & buffer) { vector selList; diff --git a/src/CutAndPaste.h b/src/CutAndPaste.h index 7d2e4a1a85..0c753fbadc 100644 --- a/src/CutAndPaste.h +++ b/src/CutAndPaste.h @@ -30,8 +30,7 @@ class Paragraph; namespace CutAndPaste { /// -std::vector -CutAndPaste::availableSelections(Buffer const & buffer); +std::vector const availableSelections(Buffer const & buffer); /// PitPosPair cutSelection(BufferParams const & params, diff --git a/src/LColor.h b/src/LColor.h index 794133b614..40c656db88 100644 --- a/src/LColor.h +++ b/src/LColor.h @@ -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); diff --git a/src/Spacing.h b/src/Spacing.h index 4d25b3fd96..03c5db7231 100644 --- a/src/Spacing.h +++ b/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. * diff --git a/src/aspell.C b/src/aspell.C index b0470339b7..4541ea01eb 100644 --- a/src/aspell.C +++ b/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. * diff --git a/src/buffer.C b/src/buffer.C index 6bf7ac231f..d3c34619e5 100644 --- a/src/buffer.C +++ b/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; diff --git a/src/converter.h b/src/converter.h index 6c0930a398..a244198e8b 100644 --- a/src/converter.h +++ b/src/converter.h @@ -126,7 +126,7 @@ public: private: /// std::vector const - Converters::intToFormat(std::vector const & input); + intToFormat(std::vector const & input); /// bool scanLog(Buffer const & buffer, std::string const & command, std::string const & filename); diff --git a/src/frontends/controllers/ChangeLog b/src/frontends/controllers/ChangeLog index 242c3fe6bd..152a2e64d0 100644 --- a/src/frontends/controllers/ChangeLog +++ b/src/frontends/controllers/ChangeLog @@ -1,3 +1,9 @@ +2003-10-08 Angus Leeming + + Fix doxygen warnings. + + * frnt_lang.h: move comment so that doxygen is not confused. + 2003-10-07 Angus Leeming * ControlExternal.[Ch]: InsetExternal::Params -> InsetExternalParams. diff --git a/src/frontends/controllers/ControlBibtex.C b/src/frontends/controllers/ControlBibtex.C index db0b95260f..d513c37504 100644 --- a/src/frontends/controllers/ControlBibtex.C +++ b/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; diff --git a/src/frontends/controllers/frnt_lang.h b/src/frontends/controllers/frnt_lang.h index 6d2c3e53b7..de12944b9b 100644 --- a/src/frontends/controllers/frnt_lang.h +++ b/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 #include -/** Ease the use of internationalised language strings in the dialogs. - */ namespace frnt { /// diff --git a/src/frontends/gnome/ChangeLog b/src/frontends/gnome/ChangeLog index 8af496f70a..7081efa709 100644 --- a/src/frontends/gnome/ChangeLog +++ b/src/frontends/gnome/ChangeLog @@ -1,3 +1,10 @@ +2003-10-08 Angus Leeming + + 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 * lyx_gui.C (parse_init): fix new bug diff --git a/src/frontends/gnome/GView.C b/src/frontends/gnome/GView.C index b2f3efc780..387c82583e 100644 --- a/src/frontends/gnome/GView.C +++ b/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. * diff --git a/src/frontends/gnome/GView.h b/src/frontends/gnome/GView.h index 8609271901..966a816bce 100644 --- a/src/frontends/gnome/GView.h +++ b/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. * diff --git a/src/frontends/gtk/Alert_pimpl.C b/src/frontends/gtk/Alert_pimpl.C index dfec643dd6..fd69a46ac6 100644 --- a/src/frontends/gtk/Alert_pimpl.C +++ b/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. * diff --git a/src/frontends/gtk/ChangeLog b/src/frontends/gtk/ChangeLog index ca1487fecb..30958b4d12 100644 --- a/src/frontends/gtk/ChangeLog +++ b/src/frontends/gtk/ChangeLog @@ -1,3 +1,12 @@ +2003-10-08 Angus Leeming + + 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 * GToolbar.C (add): Make it take a ToobarBackend::Item as arg, diff --git a/src/frontends/gtk/FileDialog.C b/src/frontends/gtk/FileDialog.C index af3cb9e191..a0338656ee 100644 --- a/src/frontends/gtk/FileDialog.C +++ b/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. * diff --git a/src/frontends/gtk/GView.C b/src/frontends/gtk/GView.C index e71763757c..aed312b427 100644 --- a/src/frontends/gtk/GView.C +++ b/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. * diff --git a/src/frontends/gtk/GView.h b/src/frontends/gtk/GView.h index 9bfb989045..039532bca5 100644 --- a/src/frontends/gtk/GView.h +++ b/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. * diff --git a/src/frontends/qt2/ChangeLog b/src/frontends/qt2/ChangeLog index 5d060b1b84..f1e2a158ac 100644 --- a/src/frontends/qt2/ChangeLog +++ b/src/frontends/qt2/ChangeLog @@ -1,3 +1,9 @@ +2003-10-08 Angus Leeming + + Fix doxygen warnings. + + * QLToolbar.h: \file qt2/Toolbar_pimpl.h -> \file QLToolbar.h + 2003-10-07 Angus Leeming * ui/QExternalDialogBase.ui: diff --git a/src/frontends/qt2/QLToolbar.h b/src/frontends/qt2/QLToolbar.h index 3f5f667975..85b2fef20b 100644 --- a/src/frontends/qt2/QLToolbar.h +++ b/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. * diff --git a/src/gettext.C b/src/gettext.C index 9e48e11d0a..2f08de5038 100644 --- a/src/gettext.C +++ b/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. * diff --git a/src/gettext.h b/src/gettext.h index a53042c100..7cb097af48 100644 --- a/src/gettext.h +++ b/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. * diff --git a/src/insets/ChangeLog b/src/insets/ChangeLog index 101474270e..46775fe0fb 100644 --- a/src/insets/ChangeLog +++ b/src/insets/ChangeLog @@ -1,3 +1,10 @@ +2003-10-08 Angus Leeming + + Fix doxygen warnings. + + * insetbox.h (localDispatch): remove prefix InsetBox:: from declaration. + * insetnote.h (localDispatch): remove prefix InsetNote:: from declaration. + 2003-10-07 Angus Leeming * ExternalTransforms.[Ch]: new files, detailing transforms that can diff --git a/src/insets/insetbox.h b/src/insets/insetbox.h index 48dbcf2366..c632653ad8 100644 --- a/src/insets/insetbox.h +++ b/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 diff --git a/src/insets/insetnote.h b/src/insets/insetnote.h index dc2a0336c9..8b93cf0786 100644 --- a/src/insets/insetnote.h +++ b/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 diff --git a/src/lyxfont.C b/src/lyxfont.C index 2c3b3c25d2..fc79dc34d0 100644 --- a/src/lyxfont.C +++ b/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. * diff --git a/src/lyxfont.h b/src/lyxfont.h index 3df9cbe2db..ab683b4e1c 100644 --- a/src/lyxfont.h +++ b/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. * diff --git a/src/support/ChangeLog b/src/support/ChangeLog index d89e3f3a00..1ba3b17ad7 100644 --- a/src/support/ChangeLog +++ b/src/support/ChangeLog @@ -1,3 +1,15 @@ +2003-10-08 Angus Leeming + + * copied_ptr.h: get rid of the swap member function. + +2003-10-08 Angus Leeming + + 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 * Makefile.am: fix typo. diff --git a/src/support/copied_ptr.h b/src/support/copied_ptr.h index 1bf94d349a..15ef7551e3 100644 --- a/src/support/copied_ptr.h +++ b/src/support/copied_ptr.h @@ -48,7 +48,6 @@ public: private: T * ptr_; - void swap(copied_ptr &); }; @@ -76,7 +75,7 @@ copied_ptr & copied_ptr::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::get() const return ptr_; } - -template -void copied_ptr::swap(copied_ptr & other) -{ - std::swap( ptr_, other.ptr_ ); -} - } // namespace support } // namespace lyx diff --git a/src/support/debugstream.h b/src/support/debugstream.h index 9619720f6b..9340def08c 100644 --- a/src/support/debugstream.h +++ b/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. * diff --git a/src/support/os.h b/src/support/os.h index 92623a7ac6..7f1be08a38 100644 --- a/src/support/os.h +++ b/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 -/// wrap OS specific stuff namespace lyx { namespace support { namespace os { diff --git a/src/tex2lyx/ChangeLog b/src/tex2lyx/ChangeLog index cf9c71491b..545f64fb7a 100644 --- a/src/tex2lyx/ChangeLog +++ b/src/tex2lyx/ChangeLog @@ -1,3 +1,14 @@ +2003-10-08 Angus Leeming + + 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 * tex2lyx.C: adjust for new debugstream. diff --git a/src/tex2lyx/Spacing.h b/src/tex2lyx/Spacing.h index fb25d35f50..cf1faa59a2 100644 --- a/src/tex2lyx/Spacing.h +++ b/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. * diff --git a/src/tex2lyx/gettext.C b/src/tex2lyx/gettext.C index 4003355c01..f2824133c6 100644 --- a/src/tex2lyx/gettext.C +++ b/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. * diff --git a/src/tex2lyx/gettext.h b/src/tex2lyx/gettext.h index f27f9fdc14..2b5c8ce3ef 100644 --- a/src/tex2lyx/gettext.h +++ b/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. * diff --git a/src/tex2lyx/lyxfont.C b/src/tex2lyx/lyxfont.C index 713d9170b5..0b9f16d93c 100644 --- a/src/tex2lyx/lyxfont.C +++ b/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. * diff --git a/src/tex2lyx/lyxfont.h b/src/tex2lyx/lyxfont.h index 0ff613a829..23e49b51b3 100644 --- a/src/tex2lyx/lyxfont.h +++ b/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. * diff --git a/src/tex2lyx/text.C b/src/tex2lyx/text.C index 76e41b055e..b716a5f93b 100644 --- a/src/tex2lyx/text.C +++ b/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. * diff --git a/src/text.C b/src/text.C index 3139a74aab..acbbf7acbf 100644 --- a/src/text.C +++ b/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. * diff --git a/src/toc.h b/src/toc.h index bb3e869285..a267a87dbe 100644 --- 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 {