Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

new api docs #111

Merged
merged 1 commit into from
Sep 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view

This file was deleted.

This file was deleted.

1 change: 0 additions & 1 deletion content/2.framework/2.genie.jl/3.API/GenieCache/_dir.yml

This file was deleted.

1 change: 0 additions & 1 deletion content/2.framework/2.genie.jl/3.API/GenieDeploy/_dir.yml

This file was deleted.

1 change: 0 additions & 1 deletion content/2.framework/2.genie.jl/3.API/GenieSession/_dir.yml

This file was deleted.

2 changes: 1 addition & 1 deletion content/2.framework/2.genie.jl/3.API/_dir.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
title: "API"
title: API
35 changes: 28 additions & 7 deletions content/2.framework/2.genie.jl/3.API/assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,10 @@ Updates the assets configuration for the current package.

::

::alert{type="info"}Missing docstring for `assets_endpoint`. ::

::alert{type="info"}
Missing docstring for `assets_endpoint`.
::


::ApiCard{object="Genie.Assets.asset_file" category="Function"}
Expand Down Expand Up @@ -121,7 +124,10 @@ Outputs the `channels.js` file included with the Genie package.

::

::alert{type="info"}Missing docstring for `channels_route`. ::

::alert{type="info"}
Missing docstring for `channels_route`.
::


::ApiCard{object="Genie.Assets.channels_script" category="Function"}
Expand All @@ -136,7 +142,10 @@ Outputs the channels JavaScript content within `<script>...</script>` tags, for

::

::alert{type="info"}Missing docstring for `channels_script_tag`. ::

::alert{type="info"}
Missing docstring for `channels_script_tag`.
::


::ApiCard{object="Genie.Assets.channels_subscribe" category="Function"}
Expand Down Expand Up @@ -241,7 +250,10 @@ Path to a js asset. `file_name` should not include the extension.

::

::alert{type="info"}Missing docstring for `jsliteral`. ::

::alert{type="info"}
Missing docstring for `jsliteral`.
::


::ApiCard{object="Genie.Assets.js_settings" category="Function"}
Expand All @@ -267,7 +279,10 @@ Outputs the webthreads.js file included with the Genie package

::

::alert{type="info"}Missing docstring for `webthreads_endpoint`. ::

::alert{type="info"}
Missing docstring for `webthreads_endpoint`.
::


::ApiCard{object="Genie.Assets.webthreads_push_pull" category="Function"}
Expand All @@ -282,7 +297,10 @@ Registers push and pull routes for `channel`.

::

::alert{type="info"}Missing docstring for `webthreads_route`. ::

::alert{type="info"}
Missing docstring for `webthreads_route`.
::


::ApiCard{object="Genie.Assets.webthreads_script" category="Function"}
Expand All @@ -297,7 +315,10 @@ Outputs the channels JavaScript content within `<script>...</script>` tags, for

::

::alert{type="info"}Missing docstring for `webthreads_script_tag`. ::

::alert{type="info"}
Missing docstring for `webthreads_script_tag`.
::


::ApiCard{object="Genie.Assets.webthreads_subscribe" category="Function"}
Expand Down
2 changes: 1 addition & 1 deletion content/2.framework/2.genie.jl/3.API/cookies.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
Dict([itr])
```

`Dict{K,V}()` constructs a hash table with keys of type `K` and values of type `V`. Keys are compared with [`isequal`]() and hashed with [`hash`]().
`Dict{K,V}()` constructs a hash table with keys of type `K` and values of type `V`. Keys are compared with [`isequal`](@ref) and hashed with [`hash`](@ref).

Given a single iterable argument, constructs a [`Dict`](cookies.md#Base.Dict) whose key-value pairs are taken from 2-tuples `(key,value)` generated by the argument.

Expand Down
55 changes: 44 additions & 11 deletions content/2.framework/2.genie.jl/3.API/generator.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@



::alert{type="info"}Missing docstring for `autoconfdb`. ::

::alert{type="info"}
Missing docstring for `autoconfdb`.
::


::ApiCard{object="Genie.Generator.autostart_app" category="Function"}
Expand All @@ -16,7 +19,10 @@ If `autostart` is `true`, the newly generated Genie app will be automatically st

::

::alert{type="info"}Missing docstring for `binfolderpath`. ::

::alert{type="info"}
Missing docstring for `binfolderpath`.
::


::ApiCard{object="Genie.Generator.controller_file_name" category="Function"}
Expand All @@ -31,7 +37,10 @@ Computes the controller file name based on the resource name.

::

::alert{type="info"}Missing docstring for `db_intializer`. ::

::alert{type="info"}
Missing docstring for `db_intializer`.
::


::ApiCard{object="Genie.Generator.db_support" category="Function"}
Expand Down Expand Up @@ -79,11 +88,17 @@ Installs the application's dependencies using Julia's Pkg

::

::alert{type="info"}Missing docstring for `install_db_dependencies`. ::

::alert{type="info"}
Missing docstring for `install_db_dependencies`.
::



::alert{type="info"}Missing docstring for `install_searchlight_dependencies`. ::

::alert{type="info"}
Missing docstring for `install_searchlight_dependencies`.
::


::ApiCard{object="Genie.Generator.microstack_app" category="Function"}
Expand Down Expand Up @@ -274,15 +289,24 @@ Creates a new Genie `Task` file.

::

::alert{type="info"}Missing docstring for `pkggenfile`. ::

::alert{type="info"}
Missing docstring for `pkggenfile`.
::




::alert{type="info"}
Missing docstring for `pkgproject`.
::

::alert{type="info"}Missing docstring for `pkgproject`. ::



::alert{type="info"}Missing docstring for `post_create`. ::
::alert{type="info"}
Missing docstring for `post_create`.
::


::ApiCard{object="Genie.Generator.remove_searchlight_initializer" category="Function"}
Expand Down Expand Up @@ -319,7 +343,10 @@ Writes the file necessary to scaffold a minimal Genie app.

::

::alert{type="info"}Missing docstring for `set_files_mod`. ::

::alert{type="info"}
Missing docstring for `set_files_mod`.
::


::ApiCard{object="Genie.Generator.setup_resource_path" category="Function"}
Expand Down Expand Up @@ -356,7 +383,10 @@ Creates the bin/server and bin/repl binaries for Windows

::

::alert{type="info"}Missing docstring for `validname`. ::

::alert{type="info"}
Missing docstring for `validname`.
::


::ApiCard{object="Genie.Generator.write_app_custom_files" category="Function"}
Expand All @@ -371,7 +401,10 @@ Writes the Genie app main module file.

::

::alert{type="info"}Missing docstring for `write_db_config`. ::

::alert{type="info"}
Missing docstring for `write_db_config`.
::


::ApiCard{object="Genie.Generator.write_resource_file" category="Function"}
Expand Down
5 changes: 4 additions & 1 deletion content/2.framework/2.genie.jl/3.API/genie.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,10 @@ julia> Genie.loadapp(".")

::

::alert{type="info"}Missing docstring for `isrunning`. ::

::alert{type="info"}
Missing docstring for `isrunning`.
::


::ApiCard{object="Genie.loadapp" category="Function"}
Expand Down
10 changes: 8 additions & 2 deletions content/2.framework/2.genie.jl/3.API/headers.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,17 @@ Makes request headers case insensitive.

::

::alert{type="info"}Missing docstring for `set_access_control_allow_headers!`. ::

::alert{type="info"}
Missing docstring for `set_access_control_allow_headers!`.
::



::alert{type="info"}Missing docstring for `set_access_control_allow_origin!`. ::

::alert{type="info"}
Missing docstring for `set_access_control_allow_origin!`.
::


::ApiCard{object="Genie.Headers.set_headers!" category="Function"}
Expand Down
5 changes: 4 additions & 1 deletion content/2.framework/2.genie.jl/3.API/httputils.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@



::alert{type="info"}Missing docstring for `HTTPUtils.Dict`. ::

::alert{type="info"}
Missing docstring for `HTTPUtils.Dict`.
::


55 changes: 44 additions & 11 deletions content/2.framework/2.genie.jl/3.API/input.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,46 +12,79 @@ Represents a file sent over HTTP

::

::alert{type="info"}Missing docstring for `HttpFormPart`. ::

::alert{type="info"}
Missing docstring for `HttpFormPart`.
::




::alert{type="info"}
Missing docstring for `HttpInput`.
::




::alert{type="info"}
Missing docstring for `all`.
::


::alert{type="info"}Missing docstring for `HttpInput`. ::


::alert{type="info"}
Missing docstring for `files`.
::

::alert{type="info"}Missing docstring for `all`. ::



::alert{type="info"}Missing docstring for `files`. ::
::alert{type="info"}
Missing docstring for `get_multiform_parts!`.
::



::alert{type="info"}Missing docstring for `get_multiform_parts!`. ::

::alert{type="info"}
Missing docstring for `parse_seicolon_fields`.
::


::alert{type="info"}Missing docstring for `parse_seicolon_fields`. ::


::alert{type="info"}
Missing docstring for `post`.
::

::alert{type="info"}Missing docstring for `post`. ::



::alert{type="info"}Missing docstring for `post_from_request!`. ::
::alert{type="info"}
Missing docstring for `post_from_request!`.
::



::alert{type="info"}Missing docstring for `parse_quoted_params`. ::

::alert{type="info"}
Missing docstring for `parse_quoted_params`.
::


::alert{type="info"}Missing docstring for `post_multipart!`. ::


::alert{type="info"}
Missing docstring for `post_multipart!`.
::



::alert{type="info"}Missing docstring for `post_url_encoded!`. ::

::alert{type="info"}
Missing docstring for `post_url_encoded!`.
::


5 changes: 4 additions & 1 deletion content/2.framework/2.genie.jl/3.API/loader.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,10 @@ Sets the module in which the code is loaded (the app's module)

::

::alert{type="info"}Missing docstring for `importenv`. ::

::alert{type="info"}
Missing docstring for `importenv`.
::


::ApiCard{object="Genie.Loader.load" category="Function"}
Expand Down
10 changes: 8 additions & 2 deletions content/2.framework/2.genie.jl/3.API/logger.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@



::alert{type="info"}Missing docstring for `initialize_logging`. ::

::alert{type="info"}
Missing docstring for `initialize_logging`.
::


::alert{type="info"}Missing docstring for `timestamp_logger`. ::


::alert{type="info"}
Missing docstring for `timestamp_logger`.
::


Loading