Fix doxygen output for grouped items. Without the /name tag doxygen shows the group name as the name of the first item. Moreover, the comment styles are somewhat standardized.

git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@33236 a592a061-630c-0410-9148-cb99ea01b6c8
This commit is contained in:
Vincent van Ravesteijn 2010-01-27 18:10:33 +00:00
parent b16e500d5c
commit a4e03846cd
15 changed files with 36 additions and 37 deletions

View File

@ -23,14 +23,14 @@ public:
AspellChecker();
~AspellChecker();
/// SpellChecker inherited methods.
///@{
/// \name SpellChecker inherited methods
//@{
enum Result check(WordLangTuple const &);
void suggest(WordLangTuple const &, docstring_list &);
void insert(WordLangTuple const &);
void accept(WordLangTuple const &);
docstring const error();
///@}
//@}
private:
struct Private;

View File

@ -41,8 +41,8 @@ class Color
public:
///
Color(ColorCode base_color = Color_none);
/// comparison operators.
/// \name Comparison operators
//@{
bool operator==(Color const & color) const;
bool operator!=(Color const & color) const;

View File

@ -82,7 +82,7 @@ public Q_SLOTS:
void doStatusMessage();
public:
/// QThread inherited methods
/// \name QThread inherited methods
//@{
void run();
//@}

View File

@ -38,11 +38,11 @@ class Paragraph;
class CursorSlice {
public:
/// Those needs inset_ access.
///@{
/// \name Those needs inset_ access.
//@{
friend class DocIterator;
friend class StableDocIterator;
///@}
//@}
/// type for cell number in inset
typedef size_t idx_type;
@ -56,7 +56,7 @@ public:
///
explicit CursorSlice(Inset &);
/// comparison operators.
/// \name Comparison operators.
//@{
friend bool operator==(CursorSlice const &, CursorSlice const &);
friend bool operator!=(CursorSlice const &, CursorSlice const &);

View File

@ -56,8 +56,8 @@ public:
/// Increases font size by one
FontInfo & incSize();
/// Accessor methods.
///@{
/// \name Accessor methods
//@{
FontFamily family() const { return family_; }
void setFamily(FontFamily f) { family_ = f; }
FontSeries series() const { return series_; }
@ -84,7 +84,7 @@ public:
void setColor(ColorCode c) { color_ = c; }
ColorCode background() const { return background_; }
void setBackground(ColorCode b) { background_ = b; }
///@}
//@}
///
void update(FontInfo const & newfont, bool toggleall);

View File

@ -23,7 +23,7 @@ public:
HunspellChecker();
~HunspellChecker();
/// SpellChecker inherited methods.
/// \name SpellChecker inherited methods.
///@{
enum Result check(WordLangTuple const &);
void suggest(WordLangTuple const &, docstring_list &);

View File

@ -47,8 +47,8 @@ public:
///
virtual ~LyXView() {}
//@{ generic accessor functions
/// \name Generic accessor functions
//@{
/// \return the currently selected buffer view.
virtual BufferView * currentBufferView() = 0;
virtual BufferView const * currentBufferView() const = 0;

View File

@ -45,9 +45,7 @@ public:
~ButtonController();
//@{
/** Methods to set and get the ButtonPolicy.
* \param ptr is owned by the ButtonController.
*/
/// Methods to set and get the ButtonPolicy.
void setPolicy(ButtonPolicy::Policy policy);
ButtonPolicy const & policy() const;
ButtonPolicy & policy();
@ -83,8 +81,9 @@ public:
*/
bool setReadOnly(bool);
/** \param validity Tell the BC that the data is, or is not, valid.
/**
* Sets the activation state of the buttons immediately.
* \param validity Tell the BC that the data is, or is not, valid.
*/
void setValid(bool);
@ -93,8 +92,7 @@ public:
//
//@{
/** Store pointers to these widgets.
*/
/// Store pointers to these widgets.
void setOK(QPushButton * obj);
void setApply(QPushButton * obj);
void setCancel(QPushButton * obj);

View File

@ -36,7 +36,7 @@ public:
virtual QWidget const * asQWidget() const { return this; }
protected:
/// Dialog inherited methods
/// \name Dialog inherited methods
//@{
void applyView() {}
bool initialiseParams(std::string const & /*data*/) { return true; }

View File

@ -56,7 +56,7 @@ public:
/// Clear all session information.
void clearSession();
/// Method inherited from \c Application class
/// \name Methods inherited from Application class
//@{
LyXView * currentWindow();
bool getStatus(FuncRequest const & cmd, FuncStatus & flag) const;
@ -85,7 +85,8 @@ public:
Toolbars & toolbars();
Menus const & menus() const;
Menus & menus();
/// Methods inherited from \c QApplication class
/// \name Methods inherited from QApplication class
//@{
bool notify(QObject * receiver, QEvent * event);
void commitData(QSessionManager & sm);

View File

@ -66,7 +66,7 @@ protected Q_SLOTS:
void change_adaptor();
private:
/// Dialog inherited methods
/// \name Dialog inherited methods
//@{
void applyView();
void updateContents();

View File

@ -26,7 +26,7 @@ class GuiInfo : public DialogView, public Ui::InfoUi
public:
GuiInfo(GuiView & lv);
/// Dialog inherited methods
/// \name Dialog inherited methods
//@{
void applyView();
void updateView();

View File

@ -62,8 +62,8 @@ public:
~GuiView();
/// LyXView inherited methods.
///@{
/// \name LyXView inherited methods.
//@{
int id() const { return id_; }
void setBusy(bool);
BufferView * currentBufferView();
@ -83,7 +83,7 @@ public:
void restartCursor();
void updateCompletion(Cursor & cur, bool start, bool keep);
void setFocus();
///@}
//@}
///
void focusInEvent(QFocusEvent * e);
@ -119,13 +119,13 @@ public:
///
void importDocument(std::string const &);
/// GuiBufferDelegate.
///@{
/// \name GuiBufferDelegate.
//@{
void resetAutosaveTimers();
void errors(std::string const &, bool from_master = false);
void structureChanged();
void updateTocItem(std::string const &, DocIterator const &);
///@}
//@}
///
TocModels & tocModels();

View File

@ -80,9 +80,9 @@ public:
/// get notification when the cursor leaves this inset
bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
/// direct access to the cell.
/// inlined because shows in profile.
//@{
/// direct access to the cell.
/// Inlined because of performance reasons.
MathData & cell(idx_type i) { return cells_[i]; }
MathData const & cell(idx_type i) const { return cells_[i]; }
//@}

View File

@ -112,11 +112,11 @@ public:
*/
FileName const & system_temp_dir() const { return system_temp_dir_; }
/** The path to the temporary directory used by LyX.
//@{
/** The path to the temporary directory used by %LyX.
* (Eg /tmp/lyx_tmpdir800nBI1z9 on *nix.)
* Can be reset by LyXRC.
*/
//@{
FileName const & temp_dir() const { return temp_dir_; }
void set_temp_dir(FileName const & temp_dir) const;
//@}