Author: AlbrechtS
Date: 2010-12-01 16:43:07 -0800 (Wed, 01 Dec 2010)
New Revision: 7936
Log:
Fixed Doxygen comments, typos, and a few indenting issues.
Part 1, more to come ...
Modified:
branches/branch-1.3/FL/Fl_Text_Buffer.H
branches/branch-1.3/FL/Fl_Text_Display.H
branches/branch-1.3/src/Fl.cxx
branches/branch-1.3/src/Fl_Text_Buffer.cxx
branches/branch-1.3/src/Fl_Text_Display.cxx
branches/branch-1.3/src/Fl_Text_Editor.cxx
Modified: branches/branch-1.3/FL/Fl_Text_Buffer.H
===================================================================
--- branches/branch-1.3/FL/Fl_Text_Buffer.H 2010-12-01 23:12:06 UTC (rev
7935)
+++ branches/branch-1.3/FL/Fl_Text_Buffer.H 2010-12-02 00:43:07 UTC (rev
7936)
@@ -599,7 +599,7 @@
\param foundPos byte offset where the character was found
\return 1 if found, 0 if not
*/
- int findchar_backward(int startPos, unsigned searchChar, int* foundPos)
const;
+ int findchar_backward(int startPos, unsigned int searchChar, int* foundPos)
const;
/**
Search forwards in buffer for string \p searchString, starting with the
Modified: branches/branch-1.3/FL/Fl_Text_Display.H
===================================================================
--- branches/branch-1.3/FL/Fl_Text_Display.H 2010-12-01 23:12:06 UTC (rev
7935)
+++ branches/branch-1.3/FL/Fl_Text_Display.H 2010-12-02 00:43:07 UTC (rev
7936)
@@ -152,7 +152,7 @@
int move_down();
int count_lines(int start, int end, bool start_pos_is_line_start) const;
int line_start(int pos) const;
- int line_end(int pos, bool start_pos_is_line_start) const;
+ int line_end(int startPos, bool startPosIsLineStart) const;
int skip_lines(int startPos, int nLines, bool startPosIsLineStart);
int rewind_lines(int startPos, int nLines);
void next_word(void);
@@ -287,7 +287,7 @@
\param x number of pixels form the left margin
\return an approximate column number based on the main font
*/
- double x_to_col(double y) const;
+ double x_to_col(double x) const;
/**
Convert a column number into an x pixel position.
Modified: branches/branch-1.3/src/Fl.cxx
===================================================================
--- branches/branch-1.3/src/Fl.cxx 2010-12-01 23:12:06 UTC (rev 7935)
+++ branches/branch-1.3/src/Fl.cxx 2010-12-02 00:43:07 UTC (rev 7936)
@@ -1771,7 +1771,7 @@
There should be an application that manages options system wide, per user, and
per application.
*/
-bool Fl::option(Fl_Option o)
+bool Fl::option(Fl_Option opt)
{
if (!options_read_) {
int tmp;
@@ -1791,9 +1791,9 @@
}
options_read_ = 1;
}
- if (o<0 || o>=OPTION_LAST)
+ if (opt<0 || opt>=OPTION_LAST)
return false;
- return (bool)options_[o];
+ return (bool)options_[opt];
}
Modified: branches/branch-1.3/src/Fl_Text_Buffer.cxx
===================================================================
--- branches/branch-1.3/src/Fl_Text_Buffer.cxx 2010-12-01 23:12:06 UTC (rev
7935)
+++ branches/branch-1.3/src/Fl_Text_Buffer.cxx 2010-12-02 00:43:07 UTC (rev
7936)
@@ -42,19 +42,19 @@
integrate their code.
With the introduction of Unicode and UTF-8, Fl_Text_... has to go into a whole
- new generation of code. Originally designed for monspaced fonts only, many
- features make les sense in the multibyte and multiwdth world of UTF-8.
-
+ new generation of code. Originally designed for monospaced fonts only, many
+ features make less sense in the multibyte and multiwidth world of UTF-8.
+
Columns are a good example. There is simply no such thing. The new Fl_Text_...
widget converts columns to pixels by multiplying them with the average
- character width for a given font
-
- Rectangular selections were rearely used (if at all) and make little sense
when
+ character width for a given font.
+
+ Rectangular selections were rarely used (if at all) and make little sense when
using variable width fonts. They have been removed.
-
+
Using multiple spaces to emulate tab stops has been replaced by pixel counting
routines. They are slower, but give the expected result for proportional
fonts.
-
+
And constantly recalculating character widths is just much too expensive.
Lines
of text are now subdivided into blocks of text which are measured at once
instead of individual characters.
@@ -128,7 +128,7 @@
mPredeleteCbArgs = NULL;
mCursorPosHint = 0;
mCanUndo = 1;
- }
+}
/*
@@ -357,7 +357,7 @@
/*
Copy a range of text from another text buffer.
- FromStart, fromEnd, and toPos must be at a character boundary.
+ fromStart, fromEnd, and toPos must be at a character boundary.
*/
void Fl_Text_Buffer::copy(Fl_Text_Buffer * fromBuf, int fromStart,
int fromEnd, int toPos)
@@ -404,7 +404,7 @@
*/
int Fl_Text_Buffer::undo(int *cursorPos)
{
- if (undowidget != this || !undocut && !undoinsert && !mCanUndo)
+ if (undowidget != this || (!undocut && !undoinsert && !mCanUndo))
return 0;
int ilen = undocut;
@@ -441,12 +441,12 @@
/*
- Set a flag is undo function will work.
+ Set a flag if undo function will work.
*/
void Fl_Text_Buffer::canUndo(char flag)
{
mCanUndo = flag;
- // disabeling undo also clears the last undo operation!
+ // disabling undo also clears the last undo operation!
if (!mCanUndo && undowidget==this)
undowidget = 0;
}
@@ -851,7 +851,8 @@
while (pos < length() && (isalnum(char_at(pos)) || char_at(pos) == '_'))
{
pos = next_char(pos);
- } return pos;
+ }
+ return pos;
}
@@ -897,7 +898,7 @@
/*
Count the number of newline characters between start and end.
- StartPos and endPos must be at a character boundary.
+ startPos and endPos must be at a character boundary.
This function is optimized for speed by not using UTF-8 calls.
*/
int Fl_Text_Buffer::count_lines(int startPos, int endPos) const {
@@ -1111,7 +1112,7 @@
/*
Insert a string into the buffer.
- Pos must be at a character boundary. Text must be a correct utf8 string.
+ Pos must be at a character boundary. Text must be a correct UTF-8 string.
*/
int Fl_Text_Buffer::insert_(int pos, const char *text)
{
@@ -1231,7 +1232,7 @@
/*
- Return if a position is inside the eselected area.
+ Return if a position is inside the selected area.
Unicode safe. Pos must be at a character boundary.
*/
int Fl_Text_Selection::includes(int pos) const {
@@ -1425,7 +1426,7 @@
/*
- Update selection range if characers were inserted.
+ Update selection range if characters were inserted.
Unicode safe. Pos must be at a character boundary.
*/
void Fl_Text_Buffer::update_selections(int pos, int nDeleted,
@@ -1462,7 +1463,7 @@
/*
Find a UCS-4 character.
- StartPos must be at a charcter boundary, searchChar is UCS-4 encoded.
+ StartPos must be at a character boundary, searchChar is UCS-4 encoded.
*/
int Fl_Text_Buffer::findchar_forward(int startPos, unsigned searchChar,
int *foundPos) const
@@ -1489,7 +1490,7 @@
/*
Find a UCS-4 character.
- StartPos must be at a charcter boundary, searchChar is UCS-4 encoded.
+ StartPos must be at a character boundary, searchChar is UCS-4 encoded.
*/
int Fl_Text_Buffer::findchar_backward(int startPos, unsigned int searchChar,
int *foundPos) const {
@@ -1512,10 +1513,10 @@
return 0;
}
-
+
/*
Insert text from a file.
- Unicode safe. Inout must be correct utf8!
+ Unicode safe. Inout must be correct UTF-8!
*/
int Fl_Text_Buffer::insertfile(const char *file, int pos, int buflen)
{
@@ -1536,7 +1537,7 @@
/*
- Write text to file,
+ Write text to file.
Unicode safe.
*/
int Fl_Text_Buffer::outputfile(const char *file, int start, int end,
@@ -1584,7 +1585,7 @@
/*
- Return the previous character poosition.
+ Return the previous character position.
Returns -1 if the beginning of the buffer is reached.
*/
int Fl_Text_Buffer::prev_char(int pos) const
@@ -1611,7 +1612,7 @@
/*
- Return the next character poosition.
+ Return the next character position.
If the end of the buffer is reached, it returns the current position.
*/
int Fl_Text_Buffer::next_char_clipped(int pos) const
@@ -1620,7 +1621,7 @@
}
/*
- Align an index to the current utf8 boundary
+ Align an index to the current UTF-8 boundary.
*/
int Fl_Text_Buffer::utf8_align(int pos) const
{
Modified: branches/branch-1.3/src/Fl_Text_Display.cxx
===================================================================
--- branches/branch-1.3/src/Fl_Text_Display.cxx 2010-12-01 23:12:06 UTC (rev
7935)
+++ branches/branch-1.3/src/Fl_Text_Display.cxx 2010-12-02 00:43:07 UTC (rev
7936)
@@ -243,7 +243,7 @@
\param unfinishedStyle if this style is found, the callback below is called
\param unfinishedHighlightCB if a character with an unfinished style is found,
this callback will be called
- \param cbArg and optional argument for the callback above, usuallay a pointer
+ \param cbArg and optional argument for the callback above, usually a pointer
to the Text Display.
*/
void Fl_Text_Display::highlight_data(Fl_Text_Buffer *styleBuffer,
@@ -279,7 +279,7 @@
/**
- \brief Change the size of the displayed text area
+ \brief Change the size of the displayed text area.
Calling this function will trigger a recalculation of all lines visible and
of all scrollbar sizes.
\param X, Y, W, H new position and size of this widget
@@ -348,7 +348,7 @@
// figure the scrollbars
if (scrollbar_width()) {
- /* Decide if the vertical scroll bar needs to be visible */
+ /* Decide if the vertical scrollbar needs to be visible */
if (scrollbar_align() & (FL_ALIGN_LEFT|FL_ALIGN_RIGHT) &&
mNBufferLines >= mNVisibleLines - 1)
{
@@ -367,9 +367,9 @@
}
/*
- Decide if the horizontal scroll bar needs to be visible. If there
+ Decide if the horizontal scrollbar needs to be visible. If there
is a vertical scrollbar, a horizontal is always created too. This
- is because the alternatives are unatractive:
+ is because the alternatives are unattractive:
* Dynamically creating a horizontal scrollbar based on the currently
visible lines is what the original nedit does, but it always wastes
space for the scrollbar even when it's not used. Since the FLTK
@@ -508,14 +508,14 @@
/**
\brief Draw a range of text.
-
- Refresh all of the text between buffer positions "start" and "end"
- not including the character at the position "end".
-
- If end points beyond the end of the buffer, refresh the whole display
- after pos, including blank lines which are not technically part of
+
+ Refresh all of the text between buffer positions \p startpos and
+ \p endpos not including the character at the position \p endpos.
+
+ If \p endpos points beyond the end of the buffer, refresh the whole display
+ after \p startpos, including blank lines which are not technically part of
any range of characters.
-
+
\param startpos index of first character to draw
\param endpos index after last character to draw
*/
@@ -564,14 +564,14 @@
draw_vline( startLine, 0, INT_MAX, startIndex, endIndex );
return;
}
-
+
/* Redisplay the first line from "start" */
draw_vline( startLine, 0, INT_MAX, startIndex, INT_MAX );
-
+
/* Redisplay the lines in between at their full width */
for ( i = startLine + 1; i < lastLine; i++ )
draw_vline( i, 0, INT_MAX, 0, INT_MAX );
-
+
/* Redisplay the last line to "end" */
draw_vline( lastLine, 0, INT_MAX, 0, endIndex );
}
@@ -595,7 +595,7 @@
/* cursor movement cancels vertical cursor motion column */
mCursorPreferredXPos = -1;
- /* erase the cursor at it's previous position */
+ /* erase the cursor at its previous position */
redisplay_range(buffer()->prev_char_clipped(mCursorPos),
buffer()->next_char(mCursorPos));
mCursorPos = newPos;
@@ -643,11 +643,11 @@
/**
\brief Set the new text wrap mode.
- If \p mode is not zero, this call enables automatic word wrapping at column
- \p pos. Word-wrapping does not change the text buffer itself, only the way
that
+ If \p wrap mode is not zero, this call enables automatic word wrapping at
column
+ \p wrapMargin. Word-wrapping does not change the text buffer itself, only the
way
the text is displayed. Different Text Displays can have different wrap modes,
even if they share the same Text Buffer.
-
+
\param wrap new wrap mode is WRAP_NONE (don't wrap text at all),
WRAP_AT_COLUMN
(wrap text at the given text column), WRAP_AT_PIXEL (wrap text at a
pixel
position), or WRAP_AT_BOUNDS (wrap text so that it fits into the
@@ -798,13 +798,13 @@
Translate a buffer text position to the XY location where the top left of the
cursor would be positioned to point to that character. Returns 0 if the
- position is not displayed because it is VERTICALLY out of view. If the
position
- is horizontally out of view, returns the X coordinate where the position
would
- be if it were visible.
-
+ position is not displayed because it is \e \b vertically out of view.
+ If the position is horizontally out of view, returns the X coordinate where
+ the position would be if it were visible.
+
\param pos character index
\param[out] X, Y pixel position of character on screen
- \return 0 if charater vertically out of view, X position otherwise
+ \return 0 if character vertically out of view, X position otherwise
*/
int Fl_Text_Display::position_to_xy( int pos, int* X, int* Y ) const {
IS_UTF8_ALIGNED2(buffer(), pos)
@@ -828,7 +828,7 @@
fontHeight = mMaxsize;
*Y = text_area.y + visLineNum * fontHeight;
- /* Get the text, length, and buffer position of the line. If the position
+ /* Get the text, length, and buffer position of the line. If the position
is beyond the end of the buffer and should be at the first position on
the first empty line, don't try to get or scan the text */
lineStartPos = mLineStarts[visLineNum];
@@ -844,21 +844,21 @@
/**
- \brief Find the line and column number of position "pos".
-
- This only works for displayed lines. If the line is not displayed, the
+ \brief Find the line and column number of position \p pos.
+
+ This only works for displayed lines. If the line is not displayed, the
function returns 0 (without the mLineStarts array it could turn in to very
long
calculation involving scanning large amounts of text in the buffer).
If continuous wrap mode is on, returns the absolute line number (as opposed
to the wrapped line number which is used for scrolling).
\param pos character index
- \param[out] lineNum absoluet (unwrapped) line number
- \param[out] column character offset to the beginning of the line *
- \return 0 if /p pos is off screen, line number otherwise
+ \param[out] lineNum absolute (unwrapped) line number
+ \param[out] column character offset to the beginning of the line
+ \return 0 if \p pos is off screen, line number otherwise
\todo a column number makes little sense in the UTF-8/variable font width
environment. We will have to further define what exactly we want to
return.
- Please check teh functions that call this particular function.
+ Please check the functions that call this particular function.
*/
int Fl_Text_Display::position_to_linecol( int pos, int* lineNum, int* column )
const {
IS_UTF8_ALIGNED2(buffer(), pos)
@@ -887,7 +887,7 @@
/**
- \brief Check if a pixel position is within the primary seection.
+ \brief Check if a pixel position is within the primary selection.
\param X, Y pixel position to test
\return 1 if position (X, Y) is inside of the primary Fl_Text_Selection
*/
@@ -944,12 +944,11 @@
needs a row, it needs it in terms of un-wrapped lines.
\param row
- \param column
\return something unknown
\todo What does this do and how is it useful? Column numbers mean little in
this context. Which functions depend on this one?
*/
-int Fl_Text_Display::wrapped_row(int row) const{
+int Fl_Text_Display::wrapped_row(int row) const {
if (!mContinuousWrap || row < 0 || row > mNVisibleLines)
return row;
return buffer()->count_lines(mFirstChar, mLineStarts[row]);
@@ -1021,8 +1020,6 @@
Cursor movement functions
*/
-
-
/**
\brief Moves the current insert position right one character.
\return 1 if the cursor moved, 0 if the end of the text was reached
@@ -1144,7 +1141,7 @@
\param startPos index to forst character
\param endPos index after last character
\param startPosIsLineStart avoid scanning back to the line start
- \retun number of lines
+ \return number of lines
*/
int Fl_Text_Display::count_lines(int startPos, int endPos,
bool startPosIsLineStart) const {
@@ -1214,9 +1211,9 @@
/**
- \brief Return the end of a line.
+ \brief Returns the end of a line.
- Same as BufEndOfLine, but takes in to account line breaks when wrapping
+ Same as BufEndOfLine, but takes into account line breaks when wrapping
is turned on. If the caller knows that startPos is at a line start, it
can pass "startPosIsLineStart" as True to make the call more efficient
by avoiding the additional step of scanning back to the last newline.
@@ -1233,21 +1230,21 @@
\param startPos index to starting character
\param startPosIsLineStart avoid scanning back to the line start
- \retun new position as index
+ \return new position as index
*/
-int Fl_Text_Display::line_end(int pos, bool startPosIsLineStart) const {
- IS_UTF8_ALIGNED2(buffer(), pos)
+int Fl_Text_Display::line_end(int startPos, bool startPosIsLineStart) const {
+ IS_UTF8_ALIGNED2(buffer(), startPos)
int retLines, retPos, retLineStart, retLineEnd;
- /* If we're not wrapping use more efficien BufEndOfLine */
+ /* If we're not wrapping use more efficient BufEndOfLine */
if (!mContinuousWrap)
- return buffer()->line_end(pos);
+ return buffer()->line_end(startPos);
- if (pos == buffer()->length())
- return pos;
+ if (startPos == buffer()->length())
+ return startPos;
- wrapped_line_counter(buffer(), pos, buffer()->length(), 1,
+ wrapped_line_counter(buffer(), startPos, buffer()->length(), 1,
startPosIsLineStart, 0, &retPos, &retLines,
&retLineStart,
&retLineEnd);
@@ -1820,7 +1817,7 @@
/**
- \brief Finde the index of the charcter that lies at the given x position.
+ \brief Finde the index of the character that lies at the given x position.
\param s UTF-8 text string
\param len length of string
\param style index into style lookup table
@@ -2195,7 +2192,7 @@
/**
- \brief Translate a pixel position into a charcter index.
+ \brief Translate a pixel position into a character index.
Translate window coordinates to the nearest (insert cursor or character
cell) text position. The parameter posType specifies how to interpret the
@@ -2572,16 +2569,16 @@
/**
- \brief Update vertical scroll bar.
+ \brief Update vertical scrollbar.
Update the minimum, maximum, slider size, page increment, and value
- for vertical scroll bar.
+ for vertical scrollbar.
*/
void Fl_Text_Display::update_v_scrollbar() {
- /* The Vert. scroll bar value and slider size directly represent the top
+ /* The vertical scrollbar value and slider size directly represent the top
line number, and the number of visible lines respectively. The scroll
bar maximum value is chosen to generally represent the size of the whole
- buffer, with minor adjustments to keep the scroll bar widget happy */
+ buffer, with minor adjustments to keep the scrollbar widget happy */
#ifdef DEBUG
printf("Fl_Text_Display::update_v_scrollbar():\n"
" mTopLineNum=%d, mNVisibleLines=%d, mNBufferLines=%d\n",
@@ -2593,12 +2590,11 @@
}
-
/**
- \brief Update vertical scroll bar.
+ \brief Update vertical scrollbar.
Update the minimum, maximum, slider size, page increment, and value
- for the horizontal scroll bar.
+ for the horizontal scrollbar.
*/
void Fl_Text_Display::update_h_scrollbar() {
int sliderMax = max(longest_vline(), text_area.w + mHorizOffset);
@@ -2608,7 +2604,7 @@
/**
- \brief Callbacks for drag or valueChanged on scroll bars.
+ \brief Callbacks for drag or valueChanged on scrollbars.
*/
void Fl_Text_Display::v_scrollbar_cb(Fl_Scrollbar* b, Fl_Text_Display* textD) {
if (b->value() == textD->mTopLineNum) return;
@@ -2618,7 +2614,7 @@
/**
- \brief Callbacks for drag or valueChanged on scroll bars.
+ \brief Callbacks for drag or valueChanged on scrollbars.
*/
void Fl_Text_Display::h_scrollbar_cb(Fl_Scrollbar* b, Fl_Text_Display* textD) {
if (b->value() == textD->mHorizOffset) return;
@@ -2718,8 +2714,8 @@
/**
- \brief Return the width in pixels of the displayed line pointed to by
"visLineNum".
- \param index into visible lines array
+ \brief Returns the width in pixels of the displayed line pointed to by
"visLineNum".
+ \param visLineNum index into visible lines array
\return width of line in pixels
*/
int Fl_Text_Display::measure_vline( int visLineNum ) const {
@@ -3321,7 +3317,7 @@
callback can't just call for a redraw, because Fl_Text_Display hasn't
processed
the original text changes yet. Anyhow, to minimize redrawing and to
avoid the complexity of scheduling redraws later, this simple protocol
- tells the text display's buffer modify callback to extend it's redraw
+ tells the text display's buffer modify callback to extend its redraw
range to show the text color/and font changes as well. */
if ( sel->selected() ) {
if ( sel->start() < *startpos ) {
Modified: branches/branch-1.3/src/Fl_Text_Editor.cxx
===================================================================
--- branches/branch-1.3/src/Fl_Text_Editor.cxx 2010-12-01 23:12:06 UTC (rev
7935)
+++ branches/branch-1.3/src/Fl_Text_Editor.cxx 2010-12-02 00:43:07 UTC (rev
7936)
@@ -3,7 +3,7 @@
//
// Copyright 2001-2010 by Bill Spitzak and others.
// Original code Copyright Mark Edel. Permission to distribute under
-// the LGPL for the FLTK library granted by Mark E.
+// the LGPL for the FLTK library granted by Mark Edel.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Library General Public
_______________________________________________
fltk-commit mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-commit
