Skip to content

Commit 023994f

Browse files
committed
Use correct bullets for scala2doc unordered lists
1 parent 697d9cb commit 023994f

File tree

5 files changed

+28
-28
lines changed

5 files changed

+28
-28
lines changed

Base/src/main/scala/Extractor.scala

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ final class Extractor[Expr[_], Type[_], -A] private[stringContextParserCombinato
9191

9292
/**
9393
* Returns an extractor which invokes the contrafn, then
94-
* * If the Expr is true, passes the value to this extractor
95-
* * If the Expr is false, fails the match
94+
* - If the Expr is true, passes the value to this extractor
95+
* - If the Expr is false, fails the match
9696
* @group Map
9797
*/
9898
def widenWith[Z](contrafn: PartialExprFunction[Expr, Z, A]):Extractor[Expr, Type, Z] =
@@ -171,9 +171,9 @@ final class Extractor[Expr[_], Type[_], -A] private[stringContextParserCombinato
171171

172172
/**
173173
* Returns a parser which invokes this parser, and then:
174-
* * If this parser run succeeded, return this internal's success
175-
* * If this parser failed and consumed input, return this parser's failure
176-
* * If this parser failed but did not consume input, run the other parser and return the other parser's result
174+
* - If this parser run succeeded, return this internal's success
175+
* - If this parser failed and consumed input, return this parser's failure
176+
* - If this parser failed but did not consume input, run the other parser and return the other parser's result
177177
*
178178
* @tparam Z the result parser's parsed value type
179179
* @param rhs the parser to call after this one

Base/src/main/scala/Interpolator.scala

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -149,8 +149,8 @@ final class Interpolator[-Expr, +A] private[stringContextParserCombinator] (
149149

150150
/**
151151
* Creates a parser that will
152-
* * when interpolating, act like this parser
153-
* * when extractoring, invoke this parser and check that the extractor input is equal to the parsed value
152+
* - when interpolating, act like this parser
153+
* - when extractoring, invoke this parser and check that the extractor input is equal to the parsed value
154154
*
155155
* The extractor parsing will probably fail if this parser expects to find holes.
156156
* @group Misc
@@ -216,9 +216,9 @@ final class Interpolator[-Expr, +A] private[stringContextParserCombinator] (
216216

217217
/**
218218
* Returns a parser which invokes this parser, and then:
219-
* * If this parser run succeeded, return this internal's success
220-
* * If this parser failed and consumed input, return this parser's failure
221-
* * If this parser failed but did not consume input, run the other parser and return the other parser's result
219+
* - If this parser run succeeded, return this internal's success
220+
* - If this parser failed and consumed input, return this parser's failure
221+
* - If this parser failed but did not consume input, run the other parser and return the other parser's result
222222
*
223223
* @tparam Z the result parser's parsed value type
224224
* @param rhs the parser to call after this one

Base/src/main/scala/Parser.scala

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -173,9 +173,9 @@ final class Parser[Expr[_], Type[_], A] private[stringContextParserCombinator] (
173173

174174
/**
175175
* Returns a parser which invokes this parser, and then:
176-
* * If this parser run succeeded, return this internal's success
177-
* * If this parser failed and consumed input, return this parser's failure
178-
* * If this parser failed but did not consume input, run the other parser and return the other parser's result
176+
* - If this parser run succeeded, return this internal's success
177+
* - If this parser failed and consumed input, return this parser's failure
178+
* - If this parser failed but did not consume input, run the other parser and return the other parser's result
179179
*
180180
* @tparam Z the result parser's parsed value type
181181
* @param rhs the parser to call after this one

Base/src/main/scala/typeclass/Repeated.scala

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ import scala.collection.mutable.Builder
77
* Describes how to combine a homogeneous sequence of zero-or-more values.
88
*
99
* When a Repeated is used:
10-
* * first, `init` to create an initial value for the accumulator
11-
* * then, `append` is called once for each component item in order, using the accumulator and the component item as parameters and returning the next accumulator value
12-
* * lastly, `result` is called with the final accumulator value, and the result of this call is overall result.
10+
* - first, `init` to create an initial value for the accumulator
11+
* - then, `append` is called once for each component item in order, using the accumulator and the component item as parameters and returning the next accumulator value
12+
* - lastly, `result` is called with the final accumulator value, and the result of this call is overall result.
1313
*
1414
* `init` will be called anew on each use, so it is possible to use a mutable accumulator
1515
* by creating a new builder in the `init` method

XmlParser/src/main/scala/XmlFactory.scala

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,20 @@ package name.rayrobdod.stringContextParserCombinatorExample.xml
33
/**
44
* A marker trait that can be implicitly picked up by XmlParser
55
*
6-
* * elements
7-
* * attributes
8-
* * values
9-
* * entities
10-
* * processInstructions
11-
* * text
12-
* * comment
13-
* * cdata
14-
* * prefixes
15-
* * uris
6+
* - elements
7+
* - attributes
8+
* - values
9+
* - entities
10+
* - processInstructions
11+
* - text
12+
* - comment
13+
* - cdata
14+
* - prefixes
15+
* - uris
1616
*
1717
* As well as methods with these names:
18-
* * literal
19-
* * interpolation
18+
* - literal
19+
* - interpolation
2020
*/
2121
trait XmlFactory
2222

0 commit comments

Comments
 (0)