anne/lyx_mirror
1
0
Fork 0
mirror of https://git.lyx.org/repos/lyx.git synced 2024-11-22 01:59:02 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

*List.h: Move the class documentation into the lyx::namespace to be picked up correctly by doxy.

Browse Source 
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@34357 a592a061-630c-0410-9148-cb99ea01b6c8
This commit is contained in:
Vincent van Ravesteijn 2010-05-03 13:36:19 +00:00
parent d9fab1ecc6
commit 9d1f1e285c
2 changed files with 38 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
src/BranchList.h
View File

@ -3,30 +3,12 @@
* \file BranchList.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Martin Vermeer
*
* Full author contact details are available in file CREDITS.
*
*
* \class Branch
*
* A class describing a 'branch', i.e., a named alternative for
* selectively outputting some parts of a document while suppressing
* other parts.
*
* A branch has a name, can either be selected or not, and uses a
* user-specifyable background colour. All these can be set and
* queried.
*
* \class BranchList
*
* A class containing a vector of all defined branches within a
* document. Has methods for selecting or deselecting branches by
* name, for outputting a '|'-separated string of all elements or only
* the selected ones, and for adding and removing elements.
*/
#ifndef BRANCHLIST_H
#define BRANCHLIST_H
@ -39,6 +21,25 @@
namespace lyx {
/**
* \class Branch
*
* A class describing a 'branch', i.e., a named alternative for
* selectively outputting some parts of a document while suppressing
* other parts.
*
* A branch has a name, can either be selected or not, and uses a
* user-specifiable background colour. All these can be set and
* queried.
*
* \class BranchList
*
* A class containing a vector of all defined branches within a
* document. It has methods for selecting or deselecting branches by
* name, for outputting a '|'-separated string of all elements or only
* the selected ones, and for adding and removing elements.
*/
class Branch {
public:
///

35
src/IndicesList.h
View File

@ -3,28 +3,12 @@
* \file IndicesList.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Jürgen Spitzmüller
*
* Full author contact details are available in file CREDITS.
*
*
* \class Index
*
* A class describing an Index type, such as "Index of Names".
* Different Index types are used in splitted Indices
*
* An Index has a name and a shortcut notation. It uses a
* user-specifyable GUI colour. All these can be set and
* queried.
*
* \class IndicesList
*
* A class containing a vector of all defined indices within a
* document. Has methods for outputting a '|'-separated string
* of all elements, and for adding, removing and renaming elements.
*/
#ifndef INDICESLIST_H
#define INDICESLIST_H
@ -37,6 +21,23 @@
namespace lyx {
/**
* \class Index
*
* A class describing an Index type, such as "Index of Names".
* Different Index types are used in splitted Indices
*
* An Index has a name and a shortcut notation. It uses a
* user-specifiable GUI colour. All these can be set and
* queried.
*
* \class IndicesList
*
* A class containing a vector of all defined indices within a
* document. It has methods for outputting a '|'-separated string
* of all elements, and for adding, removing and renaming elements.
*/
class Index {
public:
///