Changeset e75a6df for editwin.c

Timestamp:

Sep 30, 2010, 8:07:17 PM (13 years ago)

Author:

David Benjamin <davidben@mit.edu>

Branches:

master, release-1.10, release-1.7, release-1.8, release-1.9

Children:

52172cc

Parents:

c8d9f84

git-author:

David Benjamin <davidben@mit.edu> (09/29/10 13:44:00)

git-committer:

David Benjamin <davidben@mit.edu> (09/30/10 20:07:17)

Message:

Document oe_find_display_line

It took me a few readings before figuring out what it does.

File:

• editwin.c (modified) (1 diff)

editwin.c

@@ -426 +426 @@
 }
 
+/* Finds the display line of 'e' starting at the character
+ * 'index'. The index just after the line is returned. Whether the
+ * line ends at a hard break (newline) or soft break (wrapping) is
+ * returned in 'hard'.
+ *
+ * If the point (e->index) is contained in the line, its position is
+ * returned in 'x'.
+ */
 static int oe_find_display_line(owl_editwin *e, int *x, int index, int *hard)
 {