DocStrings

Value Members

1. final def !=(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

2. final def !=(arg0: Any): Boolean

   Definition Classes

   Any

3. final def ##(): Int

   Definition Classes

   AnyRef → Any

4. final def ==(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

5. final def ==(arg0: Any): Boolean

   Definition Classes

   Any

6. final def asInstanceOf[T0]: T0

   Definition Classes

   Any

7. def clone(): AnyRef

   Attributes

   protected[lang]

   Definition Classes

   AnyRef

   Annotations

   @throws()

8. final def eq(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

9. def equals(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

10. def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws()

11. def findAll(str: String, start: Int)(p: (Int) ⇒ Boolean): List[Int]

    Return first index following start and starting a line (i.

    Return first index following start and starting a line (i.e. after skipLineLead) which satisfies predicate p.

12. def findNext(str: String, start: Int)(p: (Int) ⇒ Boolean): Int

    Returns first index following start and starting a line (i.

    Returns first index following start and starting a line (i.e. after skipLineLead) or starting the comment which satisfies predicate p.

13. final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

14. def hashCode(): Int

    Definition Classes

    AnyRef → Any

15. final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

16. def mergeUsecaseSections(str: String, idxs: List[Int]): List[Int]

    Merge sections following an usecase into the usecase comment, so they can override the parent symbol's sections

17. final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

18. final def notify(): Unit

    Definition Classes

    AnyRef

19. final def notifyAll(): Unit

    Definition Classes

    AnyRef

20. def paramDocs(str: String, tag: String, sections: List[(Int, Int)]): Map[String, (Int, Int)]

    A map from parameter names to start/end indices describing all parameter sections in str tagged with tag, where sections is the index of str.

21. def returnDoc(str: String, sections: List[(Int, Int)]): Option[(Int, Int)]

    Optionally start and end index of return section in str, or None if str does not have a @return.

22. def skipIdent(str: String, start: Int): Int

    Returns index of string str following start skipping sequence of identifier characters.

23. def skipLineLead(str: String, start: Int): Int

    Returns index of string str after start skipping longest sequence of space and tab characters, possibly also containing a single * character or the /** sequence.

24. def skipToEol(str: String, start: Int): Int

    Skips to next occurrence of \n' or to the position after the /** sequence following index start.

25. def skipVariable(str: String, start: Int): Int

    Returns index following variable, or start index if no variable was recognized

26. def skipWhitespace(str: String, start: Int): Int

    Returns index of string str following start skipping longest sequence of whitespace characters characters (but no newlines)

27. def startTag(str: String, sections: List[(Int, Int)]): Int

    The first start tag of a list of tag intervals, or the end of the whole comment string - 2 if list is empty

28. def startsWithTag(str: String, start: Int, tag: String): Boolean

29. def startsWithTag(str: String, section: (Int, Int), tag: String): Boolean

    Does interval iv start with given tag?

30. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes

    AnyRef

31. def tagIndex(str: String, p: (Int) ⇒ Boolean = idx => true): List[(Int, Int)]

    Produces a string index, which is a list of sections, i.e pairs of start/end positions of all tagged sections in the string. Every section starts with a @ and extends to the next @, or to the end of the comment string, but excluding the final two characters which terminate the comment.

    Produces a string index, which is a list of sections, i.e pairs of start/end positions of all tagged sections in the string. Every section starts with a @ and extends to the next @, or to the end of the comment string, but excluding the final two characters which terminate the comment.

    Also take usecases into account - they need to expand until the next usecase or the end of the string, as they might include other sections of their own

32. def toString(): String

    Definition Classes

    AnyRef → Any

33. def variableName(str: String): String

    Extracts variable name from a string, stripping any pair of surrounding braces

34. final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws()

35. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws()

36. final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws()