Use lower case for feature marker.

This commit is contained in:
Stephen Chung
2021-07-25 22:56:05 +08:00
parent 6cb710652b
commit c7498503ba
12 changed files with 56 additions and 56 deletions

View File

@@ -40,7 +40,7 @@ pub enum FnAccess {
Private,
}
/// _(INTERNALS)_ A type containing information on a scripted function.
/// _(internals)_ A type containing information on a scripted function.
/// Exported under the `internals` feature only.
///
/// # Volatile Data Structure
@@ -68,7 +68,7 @@ pub struct ScriptFnDef {
/// Not available under `no_closure`.
#[cfg(not(feature = "no_closure"))]
pub externals: std::collections::BTreeSet<Identifier>,
/// _(METADATA)_ Function doc-comments (if any).
/// _(metadata)_ Function doc-comments (if any).
/// Exported under the `metadata` feature only.
///
/// Not available under `no_function`.
@@ -104,7 +104,7 @@ impl fmt::Display for ScriptFnDef {
#[cfg(not(feature = "no_function"))]
#[derive(Debug, Eq, PartialEq, Clone, Hash)]
pub struct ScriptFnMetadata<'a> {
/// _(METADATA)_ Function doc-comments (if any).
/// _(metadata)_ Function doc-comments (if any).
/// Exported under the `metadata` feature only.
///
/// Not available under `no_function`.
@@ -278,7 +278,7 @@ impl AST {
pub(crate) fn statements(&self) -> &[Stmt] {
&self.body.0
}
/// _(INTERNALS)_ Get the statements.
/// _(internals)_ Get the statements.
/// Exported under the `internals` feature only.
#[cfg(feature = "internals")]
#[deprecated = "this method is volatile and may change"]
@@ -303,7 +303,7 @@ impl AST {
pub(crate) fn shared_lib(&self) -> Shared<Module> {
self.functions.clone()
}
/// _(INTERNALS)_ Get the internal shared [`Module`] containing all script-defined functions.
/// _(internals)_ Get the internal shared [`Module`] containing all script-defined functions.
/// Exported under the `internals` feature only.
///
/// Not available under `no_function` or `no_module`.
@@ -323,7 +323,7 @@ impl AST {
pub(crate) fn lib(&self) -> &Module {
&self.functions
}
/// _(INTERNALS)_ Get the internal [`Module`] containing all script-defined functions.
/// _(internals)_ Get the internal [`Module`] containing all script-defined functions.
/// Exported under the `internals` feature only.
///
/// Not available under `no_function`.
@@ -344,7 +344,7 @@ impl AST {
) -> Option<Shared<crate::module::resolvers::StaticModuleResolver>> {
self.resolver.clone()
}
/// _(INTERNALS)_ Get the embedded [module resolver][crate::ModuleResolver].
/// _(internals)_ Get the embedded [module resolver][crate::ModuleResolver].
/// Exported under the `internals` feature only.
///
/// Not available under `no_module`.
@@ -762,7 +762,7 @@ impl AST {
true
}
/// _(INTERNALS)_ Recursively walk the [`AST`], including function bodies (if any).
/// _(internals)_ Recursively walk the [`AST`], including function bodies (if any).
/// Return `false` from the callback to terminate the walk.
/// Exported under the `internals` feature only.
#[cfg(feature = "internals")]
@@ -816,7 +816,7 @@ impl AsRef<Module> for AST {
}
}
/// _(INTERNALS)_ An identifier containing a name and a [position][Position].
/// _(internals)_ An identifier containing a name and a [position][Position].
/// Exported under the `internals` feature only.
///
/// # Volatile Data Structure
@@ -837,7 +837,7 @@ impl fmt::Debug for Ident {
}
}
/// _(INTERNALS)_ A type encapsulating the mode of a `return`/`throw` statement.
/// _(internals)_ A type encapsulating the mode of a `return`/`throw` statement.
/// Exported under the `internals` feature only.
///
/// # Volatile Data Structure
@@ -851,7 +851,7 @@ pub enum ReturnType {
Exception,
}
/// _(INTERNALS)_ An [`AST`] node, consisting of either an [`Expr`] or a [`Stmt`].
/// _(internals)_ An [`AST`] node, consisting of either an [`Expr`] or a [`Stmt`].
/// Exported under the `internals` feature only.
///
/// # Volatile Data Structure
@@ -875,7 +875,7 @@ impl<'a> From<&'a Expr> for ASTNode<'a> {
}
}
/// _(INTERNALS)_ A statements block.
/// _(internals)_ A statements block.
/// Exported under the `internals` feature only.
///
/// # Volatile Data Structure
@@ -950,7 +950,7 @@ impl From<StmtBlock> for Stmt {
}
}
/// _(INTERNALS)_ A statement.
/// _(internals)_ A statement.
/// Exported under the `internals` feature only.
///
/// # Volatile Data Structure
@@ -1375,7 +1375,7 @@ impl Stmt {
}
}
/// _(INTERNALS)_ A custom syntax expression.
/// _(internals)_ A custom syntax expression.
/// Exported under the `internals` feature only.
///
/// # Volatile Data Structure
@@ -1391,7 +1391,7 @@ pub struct CustomExpr {
pub tokens: StaticVec<Identifier>,
}
/// _(INTERNALS)_ A binary expression.
/// _(internals)_ A binary expression.
/// Exported under the `internals` feature only.
///
/// # Volatile Data Structure
@@ -1405,7 +1405,7 @@ pub struct BinaryExpr {
pub rhs: Expr,
}
/// _(INTERNALS)_ An op-assignment operator.
/// _(internals)_ An op-assignment operator.
/// Exported under the `internals` feature only.
///
/// # Volatile Data Structure
@@ -1443,7 +1443,7 @@ impl OpAssignment<'_> {
}
}
/// _(INTERNALS)_ An set of function call hashes.
/// _(internals)_ An set of function call hashes.
/// Exported under the `internals` feature only.
///
/// Two separate hashes are pre-calculated because of the following pattern:
@@ -1530,7 +1530,7 @@ impl FnCallHashes {
}
}
/// _(INTERNALS)_ A function call.
/// _(internals)_ A function call.
/// Exported under the `internals` feature only.
///
/// # Volatile Data Structure
@@ -1686,7 +1686,7 @@ impl FloatWrapper<FLOAT> {
}
}
/// _(INTERNALS)_ An expression sub-tree.
/// _(internals)_ An expression sub-tree.
/// Exported under the `internals` feature only.
///
/// # Volatile Data Structure