aboutsummaryrefslogtreecommitdiff
path: root/view.h
diff options
context:
space:
mode:
authorMarc André Tanner <mat@brain-dump.org>2020-07-29 11:13:53 +0200
committerMarc André Tanner <mat@brain-dump.org>2020-08-01 14:59:40 +0200
commite7b4380d785ef641583171caabf4eef9cdff07c2 (patch)
tree7a768530fdeaade1cf186bc6a047334d6f346c4a /view.h
parentb296189b7d6378ed7b6116b8506cb58f274d57ec (diff)
downloadvis-e7b4380d785ef641583171caabf4eef9cdff07c2.tar.gz
vis-e7b4380d785ef641583171caabf4eef9cdff07c2.tar.xz
doc: fix a couple of API doc warnings
In restructured text double backquotes are used for inline literals.
Diffstat (limited to 'view.h')
-rw-r--r--view.h16
1 files changed, 8 insertions, 8 deletions
diff --git a/view.h b/view.h
index 4d01564..e30946e 100644
--- a/view.h
+++ b/view.h
@@ -56,13 +56,13 @@ Filerange view_viewport_get(View*);
/**
* Get window coordinate of text position.
* @param pos The position to query.
- * @param line Will be updated with screen line on which `pos` resides.
- * @param row Will be updaded with zero based window row on which `pos` resides.
- * @param col Will be updated with zero based window column which `pos` resides.
- * @return Whether `pos` is visible. If not, the pointer arguments are left unmodified.
+ * @param line Will be updated with screen line on which ``pos`` resides.
+ * @param row Will be updaded with zero based window row on which ``pos`` resides.
+ * @param col Will be updated with zero based window column which ``pos`` resides.
+ * @return Whether ``pos`` is visible. If not, the pointer arguments are left unmodified.
*/
bool view_coord_get(View*, size_t pos, Line **line, int *row, int *col);
-/** Get position at the start ot the `n`-th window line, counting from 1. */
+/** Get position at the start ot the ``n``-th window line, counting from 1. */
size_t view_screenline_goto(View*, int n);
/** Get first screen line. */
Line *view_lines_first(View*);
@@ -147,7 +147,7 @@ void view_selections_dispose_all(View*);
void view_selections_normalize(View*);
/**
* Replace currently active selections.
- * @param array The Array of ``Filerange``s.
+ * @param array The array of ``Filerange`` objects.
* @param anchored Whether *all* selection should be anchored.
*/
void view_selections_set_all(View*, Array*, bool anchored);
@@ -176,7 +176,7 @@ int view_selections_count(View*);
/**
* Get selection index.
* @rst
- * .. note:: Is always in range `[0, count-1]`.
+ * .. note:: Is always in range ``[0, count-1]``.
* .. warning: The relative order is determined during creation and assumed
* to remain the same.
* @endrst
@@ -259,7 +259,7 @@ Line *view_cursors_line_get(Selection*);
/**
* Get zero based index of screen cell on which selection cursor currently resides.
* @rst
- * .. warning:: Returns `-1` if the selection cursor is currently not visible.
+ * .. warning:: Returns ``-1`` if the selection cursor is currently not visible.
* @endrst
*/
int view_cursors_cell_get(Selection*);