anne/lyx_mirror
1
0
Fork 0
mirror of https://git.lyx.org/repos/lyx.git synced 2024-12-22 05:16:21 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve source code documentation

Browse Source 
Adjust comments to current code and extend them a bit, also revert a part
of af5acb6d which was certainly not wanted.
This commit is contained in:
Georg Baum 2015-03-18 21:31:50 +01:00
parent 423a55acc6
commit 3b6232679d
2 changed files with 26 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/CursorSlice.h
View File

@ -32,7 +32,7 @@ class Paragraph;
/// This encapsulates a single slice of a document iterator as used e.g.
/// for cursors.
// After IU, the distinction of MathInset and InsetOld as well as
// After inset unification, the distinction of InsetMath and Inset as well as
// that of MathData and Text should vanish. They are conceptually the
// same (now...)
@ -89,7 +89,11 @@ public:
pos_type pos() const { return pos_; }
/// return the position within the paragraph
pos_type & pos() { return pos_; }
/// return the last position within the paragraph
/*!
* \return the last position within the paragraph.
* Note that this is the position behind the last character or inset,
* i.e. you cannot dereference it.
*/
pos_type lastpos() const;
/// return the number of embedded cells
size_t nargs() const { return inset_->nargs(); }
@ -152,7 +156,9 @@ private:
* Cell index of a position in this inset.
* This is the primary cell information also for grid like insets,
* although we have the convenience functions row() and col() for
* those * and column changes every time the number of columns ornumber
* those.
* This means that the corresponding idx_ of a cell in a given row
* and column changes every time the number of columns or number
* of rows changes. Normally the cursor should stay in the same cell,
* so these changes should typically be performed like the following:
* \code

25
src/support/types.h
View File

@ -20,12 +20,21 @@
namespace lyx {
/// a type for positions used in paragraphs
// needs to be signed for a while to hold the special value -1 that is
// used there
/*!
* A type for positions used in paragraphs.
* Each position is either occupied by a single character or an inset.
* For insets, the placeholder META_INSET is stored in the paragraph
* text, and the actual insets are maintained separately.
*/
// FIXME: should be unsigned, but needs to be signed for a while to
// hold the special value -1 that is used somewhere
// Note that the signed property is also used in loops counting to zero.
typedef ptrdiff_t pos_type;
/// a type for paragraph offsets
/*!
* A type for paragraph offsets.
* This is used to address paragraphs in ParagraphList, Text etc.
*/
// FIXME: should be unsigned as well.
// however, simply changing it breaks a downward loop somewhere...
typedef ptrdiff_t pit_type;
@ -47,13 +56,13 @@ namespace lyx {
struct size_type {
///
typedef size_t base_type;
typedef size_t base_type;
///
size_type(base_type t) { data_ = t; }
///
operator base_type() const { return data_; }
///
private:
private:
base_type data_;
};
@ -61,8 +70,8 @@ namespace lyx {
///
enum word_location {
// the word around the cursor, only if the cursor is
//not at a boundary
/// the word around the cursor, only if the cursor is
/// not at a boundary
WHOLE_WORD_STRICT,
// the word around the cursor
WHOLE_WORD,