Rename set_doc_comments to enable_doc_comments.

RELEASES.md

@@ -13,6 +13,7 @@ Breaking changes
 
 * Rust compiler requirement raised to 1.49.
 * `NativeCallContext::new` taker an additional parameter containing the name of the function called.
+* `Engine::set_doc_comments` is renamed `Engine::enable_doc_comments`.
 
 Bug fixes
 ---------

src/engine.rs

@@ -545,32 +545,37 @@ impl State {
 #[derive(Debug, Clone, Eq, PartialEq, Hash)]
 pub struct Limits {
     /// Maximum levels of call-stack to prevent infinite recursion.
-    /// Not available under `no_function`.
     ///
     /// Set to zero to effectively disable function calls.
+    ///
+    /// Not available under `no_function`.
     #[cfg(not(feature = "no_function"))]
     pub max_call_stack_depth: usize,
     /// Maximum depth of statements/expressions at global level.
     pub max_expr_depth: Option<NonZeroUsize>,
     /// Maximum depth of statements/expressions in functions.
+    ///
     /// Not available under `no_function`.
     #[cfg(not(feature = "no_function"))]
     pub max_function_expr_depth: Option<NonZeroUsize>,
     /// Maximum number of operations allowed to run.
     pub max_operations: Option<NonZeroU64>,
     /// Maximum number of [modules][Module] allowed to load.
-    /// Not available under `no_module`.
     ///
     /// Set to zero to effectively disable loading any [module][Module].
+    ///
+    /// Not available under `no_module`.
     #[cfg(not(feature = "no_module"))]
     pub max_modules: usize,
     /// Maximum length of a [string][ImmutableString].
     pub max_string_size: Option<NonZeroUsize>,
     /// Maximum length of an [array][Array].
+    ///
     /// Not available under `no_index`.
     #[cfg(not(feature = "no_index"))]
     pub max_array_size: Option<NonZeroUsize>,
     /// Maximum number of properties in an [object map][Map].
+    ///
     /// Not available under `no_object`.
     #[cfg(not(feature = "no_object"))]
     pub max_map_size: Option<NonZeroUsize>,

src/engine_settings.rs

@@ -34,7 +34,7 @@ impl Engine {
     }
     /// Enable/disable doc-comments.
     #[inline(always)]
-    pub fn set_doc_comments(&mut self, enable: bool) -> &mut Self {
+    pub fn enable_doc_comments(&mut self, enable: bool) -> &mut Self {
         self.disable_doc_comments = !enable;
         self
     }

src/fn_func.rs

@@ -8,6 +8,7 @@ use crate::stdlib::{boxed::Box, string::ToString};
 use crate::{Engine, EvalAltResult, ParseError, Scope, AST};
 
 /// Trait to create a Rust closure from a script.
+///
 /// Not available under `no_function`.
 pub trait Func<ARGS, RET> {
     type Output;

tests/comments.rs

@@ -12,10 +12,10 @@ fn test_comments() -> Result<(), Box<EvalAltResult>> {
     assert_eq!(
         engine.eval::<INT>(
             r#"
-            let /* I am a
-                multi-line
-                    comment, yay!
-                */ x = 42; x
+                let /* I am a
+                    multi-line
+                        comment, yay!
+                    */ x = 42; x
             "#
         )?,
         42
@@ -88,7 +88,7 @@ fn test_comments_doc() -> Result<(), Box<EvalAltResult>> {
         )
         .is_err());
 
-    engine.set_doc_comments(false);
+    engine.enable_doc_comments(false);
 
     engine.compile(
         r"