diff --git a/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/deprecated.html b/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/deprecated.html index c07a44b..5b8b4e2 100644 --- a/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/deprecated.html +++ b/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/deprecated.html @@ -1,5 +1,5 @@ - + apiDoc - Deprecated apiDoc params @@ -709,4 +709,4 @@

MIT License

- \ No newline at end of file + \ No newline at end of file diff --git a/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/example/index.html b/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/example/index.html index 56a7df8..9b52ba6 100644 --- a/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/example/index.html +++ b/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/example/index.html @@ -1,7 +1,7 @@ - + Loading... @@ -659,5 +659,5 @@

{{__ compare.key}}

- + diff --git a/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/example_basic/index.html b/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/example_basic/index.html index 355cf84..499899f 100644 --- a/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/example_basic/index.html +++ b/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/example_basic/index.html @@ -1,7 +1,7 @@ - + Loading... @@ -659,5 +659,5 @@

{{__ compare.key}}

- + diff --git a/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/example_inherit/index.html b/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/example_inherit/index.html index 3fbc6d8..9291490 100644 --- a/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/example_inherit/index.html +++ b/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/example_inherit/index.html @@ -1,7 +1,7 @@ - + Loading... @@ -659,5 +659,5 @@

{{__ compare.key}}

- + diff --git a/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/example_versioning/index.html b/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/example_versioning/index.html index 7367e79..eac1aa8 100644 --- a/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/example_versioning/index.html +++ b/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/example_versioning/index.html @@ -1,7 +1,7 @@ - + Loading... @@ -659,5 +659,5 @@

{{__ compare.key}}

- + diff --git a/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/index-2.html b/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/index-2.html index 75c6bb5..11ffc7f 100644 --- a/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/index-2.html +++ b/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/index-2.html @@ -1,7 +1,7 @@ - + apiDoc - Inline Documentation for RESTful web APIs @@ -36,6 +36,7 @@

apiDoc creates a documentation from API annotations in your source code.

  • Java, JavaScript, PHP, ...
  • CoffeeScript
  • +
  • Elixir
  • Erlang
  • Perl
  • Python
  • @@ -70,6 +71,20 @@

    apiDoc creates a documentation from API annotations in your source code.

    + +
    +
    @apidoc """
    +@api {get} /user/:id Request User information
    +@apiName GetUser
    +@apiGroup User
    +
    +@apiParam {Number} id Users unique ID.
    +
    +@apiSuccess {String} firstname Firstname of the User.
    +@apiSuccess {String} lastname  Lastname of the User.
    +"""
    +
    +
    %{
    @@ -230,6 +245,11 @@ 

    Preface

    This is a comment. ###
    +

    Elixir

    +
    @apidoc """
    +This is a comment.
    +"""
    +

    Erlang (% within the comment is optional)

    %{
     % This is a comment.
    @@ -374,7 +394,7 @@ 

    Configuration (apidoc.json)

    "description": "apiDoc basic example", "apidoc": { "title": "Custom apiDoc browser title", - "url" : "https://api.github.com/v1", + "url" : "https://api.github.com/v1" } }
    @@ -438,7 +458,7 @@

    Settings for apidoc.json

    order - A list of api-names / group-names for ordering the output. Not defined names are automatically displayd last.
    + A list of api-names / group-names for ordering the output. Not defined names are automatically displayed last.
    "order": [
       "Error",
       "Define",
    @@ -738,13 +758,12 @@ 

    Versioning

    Full example (all together)

    -

    This is a complex example with inherit, versioning, API.md file and history file _apidoc.js, explanation is within code and generated documentation.

    +

    This is a complex example with inherit, versioning file and history file _apidoc.js, explanation is within code and generated documentation.

    View example output


    Files:

    @@ -1801,5 +1820,5 @@

    MIT License

    - + diff --git a/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/index.html b/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/index.html index 1046fab..1f4e932 100644 --- a/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/index.html +++ b/apiDoc.docset/Contents/Resources/Documents/apidocjs.com/index.html @@ -1,5 +1,5 @@ - + apiDoc - Inline Documentation for RESTful web APIs @@ -117,6 +117,11 @@

    Preface

    This is a comment. ###
    +

    Elixir

    +
    @apidoc """
    +This is a comment.
    +"""
    +

    Erlang (% within the comment is optional)

    %{
     % This is a comment.
    @@ -261,7 +266,7 @@ 

    @@ -325,7 +330,7 @@

    Settings for apidoc.json

    order - A list of api-names / group-names for ordering the output. Not defined names are automatically displayd last.
    + A list of api-names / group-names for ordering the output. Not defined names are automatically displayed last.
    "order": [
       "Error",
       "Define",
    @@ -625,13 +630,12 @@ 

    Versionin

    Full example (all together)

    -

    This is a complex example with inherit, versioning, API.md file and history file _apidoc.js, explanation is within code and generated documentation.

    +

    This is a complex example with inherit, versioning file and history file _apidoc.js, explanation is within code and generated documentation.

    View example output


    Files:

    @@ -1650,4 +1654,4 @@

    MIT License

    - \ No newline at end of file + \ No newline at end of file diff --git a/apiDoc.docset/Contents/Resources/docSet.dsidx b/apiDoc.docset/Contents/Resources/docSet.dsidx index a87a0f3..0c6e4fa 100644 Binary files a/apiDoc.docset/Contents/Resources/docSet.dsidx and b/apiDoc.docset/Contents/Resources/docSet.dsidx differ diff --git a/apiDoc.xml b/apiDoc.xml index f66bf88..b769a62 100644 --- a/apiDoc.xml +++ b/apiDoc.xml @@ -1,4 +1,4 @@ - 1.0.1 - https://github.com/pfefferle/dash-apidoc/releases/download/1.0.1/apiDoc.tgz + 1.0.2 + https://github.com/pfefferle/dash-apidoc/releases/download/1.0.2/apiDoc.tgz