Refine docs and comments etc.

This commit is contained in:
Stephen Chung
2021-01-02 23:30:10 +08:00
parent 5a3bbaa322
commit ef48f47b74
22 changed files with 352 additions and 296 deletions

View File

@@ -149,7 +149,7 @@ impl fmt::Debug for Position {
/// _(INTERNALS)_ A Rhai language token.
/// Exported under the `internals` feature only.
///
/// ## WARNING
/// # WARNING
///
/// This type is volatile and may change.
#[derive(Debug, PartialEq, Clone)]
@@ -741,7 +741,7 @@ impl From<Token> for String {
/// _(INTERNALS)_ State of the tokenizer.
/// Exported under the `internals` feature only.
///
/// ## WARNING
/// # WARNING
///
/// This type is volatile and may change.
#[derive(Debug, Clone, Eq, PartialEq, Default)]
@@ -763,7 +763,7 @@ pub struct TokenizeState {
/// _(INTERNALS)_ Trait that encapsulates a peekable character input stream.
/// Exported under the `internals` feature only.
///
/// ## WARNING
/// # WARNING
///
/// This trait is volatile and may change.
pub trait InputStream {
@@ -777,7 +777,7 @@ pub trait InputStream {
/// _(INTERNALS)_ Parse a string literal wrapped by `enclosing_char`.
/// Exported under the `internals` feature only.
///
/// ## WARNING
/// # WARNING
///
/// This type is volatile and may change.
pub fn parse_string_literal(
@@ -968,7 +968,7 @@ fn scan_block_comment(
/// _(INTERNALS)_ Get the next token from the `stream`.
/// Exported under the `internals` feature only.
///
/// ## WARNING
/// # WARNING
///
/// This type is volatile and may change.
#[inline]