diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 00000000..4cb644fa --- /dev/null +++ b/.editorconfig @@ -0,0 +1,16 @@ +# EditorConfig helps developers define and maintain consistent +# coding styles between different editors and IDEs +# editorconfig.org + +root = true + +[*] +indent_style = space +indent_size = 4 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = false + +[*.md] +trim_trailing_whitespace = false \ No newline at end of file diff --git a/about-block-inline-tags.html b/about-block-inline-tags.html index d45f01aa..20e8b834 100644 --- a/about-block-inline-tags.html +++ b/about-block-inline-tags.html @@ -17,10 +17,13 @@ -
- @use JSDoc +
+ +
-
+

Block and inline tags

Table of Contents

    @@ -55,8 +58,7 @@

    Examples

    Shoe.prototype.setColor = function(color) { // ... }; - - +

    You can use inline tags within a description, as shown above, or within a block tag, as shown below:

    Inline tag used within a block tag
    /**
    @@ -68,8 +70,7 @@ 

    Examples

    Shoe.prototype.setColor = function(color) { // ... }; -
    -
    +

    When you use multiple block tags in a JSDoc comment, they must be separated by line breaks:

    Multiple block tags separated by line breaks
    /**
    @@ -81,13 +82,11 @@ 

    Examples

    Shoe.prototype.setLaceType = function(color, type) { // ... }; -
    -
    +
-