o

scala.tools.nsc.util

DocStrings

object DocStrings

Utility methods for doc comment strings

Source
DocStrings.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocStrings
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. def cleanupSectionText(str: String): String

    Cleanup section text

  2. def extractSectionParam(str: String, section: (Int, Int)): String

    Extract the section parameter

  3. def extractSectionTag(str: String, section: (Int, Int)): String

    Extract the section tag, treating the section tag as an identifier

  4. def extractSectionText(str: String, section: (Int, Int)): (Int, Int)

    Extract the section text, except for the tag and comment newlines

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

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

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

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

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

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

  7. def groupDoc(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 @group.

  8. def mergeInheritdocSections(str: String, idxs: List[Int]): List[Int]

    Merge the inheritdoc sections, as they never make sense on their own

  9. 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

  10. 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.

  11. 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.

  12. def sectionTagMap(str: String, sections: List[(Int, Int)]): Map[String, (Int, Int)]

    A map from the section tag to section parameters

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

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

  14. 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.

  15. def skipTag(str: String, start: Int): Int

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

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

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

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

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

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

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

  19. 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

  20. def startsWithTag(str: String, start: Int, tag: String): Boolean
  21. def startsWithTag(str: String, section: (Int, Int), tag: String): Boolean

    Does interval iv start with given tag?

  22. 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.

    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 an at sign and extends to the next at sign, 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

  23. def variableName(str: String): String

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