diff options
author | michelou <michelou@epfl.ch> | 2011-07-13 20:31:32 +0000 |
---|---|---|
committer | michelou <michelou@epfl.ch> | 2011-07-13 20:31:32 +0000 |
commit | 5e49b4181976f20d28625008a775223dbf8e7f6e (patch) | |
tree | 7c6b89abee9c86801614b8fa081f3cf88bcfe6f6 /src/library/scala/io/Position.scala | |
parent | c614e932d01668cda6506fcb431a2f719f0a71f0 (diff) | |
download | scala-5e49b4181976f20d28625008a775223dbf8e7f6e.tar.gz scala-5e49b4181976f20d28625008a775223dbf8e7f6e.tar.bz2 scala-5e49b4181976f20d28625008a775223dbf8e7f6e.zip |
cleanups (scaladoc 2, deprecation warnings, tra...
cleanups (scaladoc 2, deprecation warnings, trailing blanks)
Diffstat (limited to 'src/library/scala/io/Position.scala')
-rw-r--r-- | src/library/scala/io/Position.scala | 24 |
1 files changed, 13 insertions, 11 deletions
diff --git a/src/library/scala/io/Position.scala b/src/library/scala/io/Position.scala index 917d61ec25..5d1e695add 100644 --- a/src/library/scala/io/Position.scala +++ b/src/library/scala/io/Position.scala @@ -10,24 +10,26 @@ package scala.io /** The object Position provides convenience methods to encode * line and column number in one single integer. The encoded line - * (column) numbers range from 0 to LINE_MASK (COLUMN_MASK), - * where 0 indicates that the line (column) is undefined and 1 - * represents the first line (column). + * (column) numbers range from 0 to `LINE_MASK` (`COLUMN_MASK`), + * where `0` indicates that the line (column) is undefined and + * `1` represents the first line (column). * - * Line (Column) numbers greater than LINE_MASK (COLUMN_MASK) are - * replaced by LINE_MASK (COLUMN_MASK). Furthermore, if the encoded - * line number is LINE_MASK, the column number is always set to 0. + * Line (Column) numbers greater than `LINE_MASK` (`COLUMN_MASK`) are + * replaced by `LINE_MASK` (`COLUMN_MASK`). Furthermore, if the encoded + * line number is `LINE_MASK`, the column number is always set to 0. * * The following properties hold: * - * the undefined position is 0: encode(0,0) == 0 - * encodings are non-negative : encode(line,column) >= 0 + * the undefined position is 0: `encode(0,0) == 0` + * encodings are non-negative : `encode(line,column) >= 0` * position order is preserved: - * + * {{{ * (line1 <= line2) || (line1 == line2 && column1 <= column2) - * implies + * }}} + * implies + * {{{ * encode(line1,column1) <= encode(line2,column2) - * + * }}} * @author Burak Emir (translated from work by Matthias Zenger and others) */ abstract class Position { |