Skip to content

Commit

Permalink
Corrected missing parameter documentation caused by the @define doc-m…
Browse files Browse the repository at this point in the history
…acro
  • Loading branch information
j-mie6 committed Jan 31, 2023
1 parent 3fd6737 commit 38858c4
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -88,12 +88,8 @@ object BreakCharDesc {
final case class Supported(breakChar: Char, allowedAfterNonDecimalPrefix: Boolean) extends BreakCharDesc
}

// TODO: configurable dot?
/** This class describes how numeric literals, in different bases, should be processed lexically.
*
* @define generic is it possible for generic
* @define genericInt $generic "integer numbers" to be
* @define genericReal $generic "real numbers" to be
* @define genericExp Describes how scientific exponent notation should work for
*
* @param literalBreakChar describes if breaks can be found within numeric literals.
* @param leadingDotAllowed can a real number omit a leading 0 before the point?
Expand All @@ -114,8 +110,11 @@ object BreakCharDesc {
* @param octalExponentDesc $genericExp octal literals.
* @param binaryExponentDesc $genericExp binary literals.
* @since 4.0.0
*
* @define genericInt is it possible for generic "integer numbers" to be
* @define genericReal is it possible for generic "real numbers" to be
* @define genericExp describes how scientific exponent notation should work for
*/
// TODO: configurable dot?
final case class NumericDesc (literalBreakChar: BreakCharDesc,
leadingDotAllowed: Boolean,
trailingDotAllowed: Boolean,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,6 @@ object NumericEscape {
* from single or multiple characters to specific values, numeric escape sequences with different
* bases, as well as supporting zero-width escapes and line continuations via string gaps.
*
* @define numericEscape if allowed, the description of how numeric escape seqeunces work for base
*
* @param escBegin the character that starts an escape sequence, very often this is `'\\'`.
* @param literals the characters that can be directly escaped, but still represent themselves, for instance `'"'`, or `'\\'`.
* @param singleMap the possible single-character escape sequences and the (full UTF-16) character they map to, for instance `'n' -> 0xa`.
Expand All @@ -85,6 +83,8 @@ object NumericEscape {
escape sequences: in Haskell this would be `\&`.
* @param gapsSupported specifies whether or not ''string gaps'' are supported: this is where whitespace can be injected between two
* `escBegin` characters and this will all be ignored in the final string, such that `"hello \ \world"` is `"hello world"`.
*
* @define numericEscape if allowed, the description of how numeric escape sequences work for base
* @since 4.0.0
*/
final case class EscapeDesc (escBegin: Char,
Expand Down

0 comments on commit 38858c4

Please sign in to comment.