src/location: add doc to `Location::column_start`
authorAlexis Laferrière <alexis.laf@xymus.net>
Tue, 2 Dec 2014 15:10:02 +0000 (10:10 -0500)
committerAlexis Laferrière <alexis.laf@xymus.net>
Tue, 2 Dec 2014 21:36:42 +0000 (16:36 -0500)
Signed-off-by: Alexis Laferrière <alexis.laf@xymus.net>

src/location.nit

index 8ed4428..e82775a 100644 (file)
@@ -54,7 +54,16 @@ class Location
        var file: nullable SourceFile
        var line_start: Int
        var line_end: Int
+
+       # Start of this location on `line_start`
+       #
+       # A `column_start` of 1 means the first column or character.
+       #
+       # If `column_start == 0` this location concerns the whole line.
+       #
+       # Require: `column_start >= 0`
        var column_start: Int
+
        var column_end: Int
 
        # The index in the start character in the source