diff --git a/.github/workflows/jekyll.yml b/.github/workflows/jekyll.yml new file mode 100644 index 000000000..297fd2e42 --- /dev/null +++ b/.github/workflows/jekyll.yml @@ -0,0 +1,67 @@ +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + +# Sample workflow for building and deploying a Jekyll site to GitHub Pages +name: Deploy Jekyll site to Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: ["main"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Ruby + uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0 + with: + # ruby-version: '3.1' # Not needed with a .ruby-version file + bundler-cache: true # runs 'bundle install' and caches installed gems automatically + cache-version: 0 # Increment this number if you need to re-download cached gems + - name: Setup Pages + id: pages + uses: actions/configure-pages@v4 + - name: Build with Jekyll + # Outputs to the './_site' directory by default + run: cd ./docs + run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" + env: + JEKYLL_ENV: production + - name: Upload artifact + # Automatically uploads an artifact from the './_site' directory by default + uses: actions/upload-pages-artifact@v3 + with: + path: ./docs/_site + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/docs/Gemfile b/docs/Gemfile index 568b1710f..a7e9c457e 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -3,4 +3,6 @@ gem 'jekyll' gem 'jekyll-redirect-from', group: [:jekyll_plugins] gem 'jekyll-compose', group: [:jekyll_plugins] gem "jekyll-remote-theme", group: [:jekyll_plugins] -gem 'jekyll-theme-adobe-hyde', path: '../../../stlab/hyde-theme' +# don't submit this line to the upstream repo +## Enable this line for local theme development +# gem 'jekyll-theme-adobe-hyde', path: '../../themes' diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index f8ba7b2a2..5e7e16fb8 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -1,14 +1,7 @@ -PATH - remote: ../../../stlab/hyde-theme - specs: - jekyll-theme-adobe-hyde (2.0.1) - jekyll (~> 4.3) - jekyll-seo-tag (~> 2.0) - GEM remote: https://rubygems.org/ specs: - addressable (2.8.5) + addressable (2.8.6) public_suffix (>= 2.0.2, < 6.0) colorator (1.1.0) concurrent-ruby (1.2.2) @@ -16,13 +9,18 @@ GEM eventmachine (>= 0.12.9) http_parser.rb (~> 0) eventmachine (1.2.7) - ffi (1.15.5) + ffi (1.16.3) forwardable-extended (2.6.0) - google-protobuf (3.24.3-x86_64-linux) + google-protobuf (3.25.2) + google-protobuf (3.25.2-aarch64-linux) + google-protobuf (3.25.2-arm64-darwin) + google-protobuf (3.25.2-x86-linux) + google-protobuf (3.25.2-x86_64-darwin) + google-protobuf (3.25.2-x86_64-linux) http_parser.rb (0.8.0) i18n (1.14.1) concurrent-ruby (~> 1.0) - jekyll (4.3.2) + jekyll (4.3.3) addressable (~> 2.4) colorator (~> 1.0) em-websocket (~> 0.5) @@ -49,8 +47,6 @@ GEM rubyzip (>= 1.3.0, < 3.0) jekyll-sass-converter (3.0.0) sass-embedded (~> 1.54) - jekyll-seo-tag (2.8.0) - jekyll (>= 3.8, < 5.0) jekyll-watch (2.2.1) listen (~> 3.0) kramdown (2.4.0) @@ -64,30 +60,70 @@ GEM mercenary (0.4.0) pathutil (0.16.2) forwardable-extended (~> 2.6) - public_suffix (5.0.3) + public_suffix (5.0.4) rb-fsevent (0.11.2) rb-inotify (0.10.1) ffi (~> 1.0) rexml (3.2.6) - rouge (4.1.3) + rouge (4.2.0) rubyzip (2.3.2) safe_yaml (1.0.5) - sass-embedded (1.66.1-x86_64-linux-gnu) - google-protobuf (~> 3.23) + sass-embedded (1.69.7-aarch64-linux-android) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-aarch64-linux-gnu) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-aarch64-linux-musl) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-arm-linux-androideabi) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-arm-linux-gnueabihf) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-arm-linux-musleabihf) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-arm64-darwin) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-x86-linux-android) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-x86-linux-gnu) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-x86-linux-musl) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-x86_64-darwin) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-x86_64-linux-android) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-x86_64-linux-gnu) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-x86_64-linux-musl) + google-protobuf (~> 3.25) terminal-table (3.0.2) unicode-display_width (>= 1.1.1, < 3) - unicode-display_width (2.4.2) + unicode-display_width (2.5.0) webrick (1.8.1) PLATFORMS - x86_64-linux + aarch64-linux + aarch64-linux-android + aarch64-linux-gnu + aarch64-linux-musl + arm-linux-androideabi + arm-linux-gnueabihf + arm-linux-musleabihf + arm64-darwin + x86-linux + x86-linux-android + x86-linux-gnu + x86-linux-musl + x86_64-darwin + x86_64-linux-android + x86_64-linux-gnu + x86_64-linux-musl DEPENDENCIES jekyll jekyll-compose jekyll-redirect-from jekyll-remote-theme - jekyll-theme-adobe-hyde! BUNDLED WITH - 2.4.19 + 2.5.4 diff --git a/docs/_config.yml b/docs/_config.yml index 1ee462ec9..1bec67a0b 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -15,8 +15,10 @@ baseurl: "" # the subpath of your site, e.g. /blog url: "http://www.stlab.cc" # the base hostname & protocol for your site twitter_username: SeanParent github_username: stlab -# remote_theme: adobe/hyde-theme@v2.0.1 -theme: jekyll-theme-adobe-hyde + +## To build locally, toggle these two. +remote_theme: adobe/hyde-theme@v2.0.1 +# theme: jekyll-theme-adobe-hyde exclude: - _source - build diff --git a/docs/about.md b/docs/about.md index 59fc3e0cf..f7da9d726 100644 --- a/docs/about.md +++ b/docs/about.md @@ -1,8 +1,9 @@ --- layout: page title: About -tab: About permalink: /about/ +hyde: + tab: About --- stlab is the ongoing work of what was Adobe's Software Technology Lab. The Adobe Source Libraries (ASL), Platform Libraries, and new stlab libraries are hosted on [github](https://github.com/stlab). diff --git a/docs/chat.md b/docs/chat.md index 3b38b9e6c..cd64707f9 100644 --- a/docs/chat.md +++ b/docs/chat.md @@ -1,8 +1,9 @@ --- layout: page title: Chat -tab: Chat permalink: /chat/ +hyde: + tab: Chat --- For video chats use the Google Hangout below (requires a Google account). diff --git a/docs/index.html b/docs/index.html index 56ee02198..de32ea08c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2,18 +2,18 @@ layout: default --- -{% assign home_thumbs = site.pages | where_exp:"p","p.icon" | sort:"tab"%} +{% assign home_thumbs = site.pages | where_exp:"p","p.hyde.icon" | sort:"hyde.tab"%}
{% for page in home_thumbs %}
- {% if page.icon %} + {% if page.hyde.icon %}
-
-
{{page.tab}}
+
+
{{page.hyde.tab}}
 {% endif %} diff --git a/docs/legacy/index.md b/docs/legacy/index.md index f5ff9582a..46c6d45b2 100644 --- a/docs/legacy/index.md +++ b/docs/legacy/index.md @@ -1,9 +1,10 @@ --- title: Welcome to the stlab.adobe.com Wiki -tab: Legacy layout: page redirect_from: /legacy/index.php/Main_Page -icon: pagelines +hyde: + tab: Legacy + icon: leaf --- _These pages have been migrated from stlab.adobe.com/wiki for preservation. They may eventually be revised and moved into a more appropriate location on the site._ diff --git a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/set_ready.md b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/set_ready.md deleted file mode 100644 index 4a79fd2c8..000000000 --- a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/set_ready.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -layout: method -title: set_ready -tags: [library] -scope: receiver -pure-name: set_ready -defined-in-header: stlab/concurrency/channel.hpp -declaration: set_ready -brief: Sets the receiver ready to receive values. -description: Sets the receiver ready to receive values. -example: set_ready_example.cpp -entities: - - kind: methods - list: - - name: stlab::receiver::set_ready - pure-name: set_ready - defined-in-header: stlab/concurrency/channel.hpp - declaration: void set_ready() - description: Sets this receiver ready to receiver values. That implies that no more downstream processes can be attached. - - kind: parameters - - kind: result ---- diff --git a/docs/libraries/concurrency/default_executor.hpp/executor_type3CP3E/index.md b/docs/libraries/concurrency/default_executor.hpp/executor_type3CP3E/index.md deleted file mode 100644 index 2d087021a..000000000 --- a/docs/libraries/concurrency/default_executor.hpp/executor_type3CP3E/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -layout: class -title: executor_type

-owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/default_executor.hpp -declaration: "template \nstruct stlab::detail::executor_type;" -ctor: unspecified -dtor: unspecified -typedefs: - result_type: - definition: void - description: __MISSING__ -namespace: - - stlab - - v1 - - detail ---- diff --git a/docs/libraries/concurrency/default_executor.hpp/executor_type3CP3E/m_operator2829.md b/docs/libraries/concurrency/default_executor.hpp/executor_type3CP3E/m_operator2829.md deleted file mode 100644 index 2c12169b2..000000000 --- a/docs/libraries/concurrency/default_executor.hpp/executor_type3CP3E/m_operator2829.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method -title: operator() -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/default_executor.hpp -overloads: - "template \nvoid operator()(F) const": - arguments: - - description: __OPTIONAL__ - name: f - type: F - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nvoid operator()(F f) const" ---- diff --git a/docs/libraries/concurrency/default_executor.hpp/f_group.md b/docs/libraries/concurrency/default_executor.hpp/f_group.md deleted file mode 100644 index 93765ff47..000000000 --- a/docs/libraries/concurrency/default_executor.hpp/f_group.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: function -title: group -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/default_executor.hpp -overloads: - stlab::detail::group_t & group(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: stlab::detail::group_t & group() -namespace: - - stlab - - v1 - - detail ---- diff --git a/docs/libraries/concurrency/default_executor.hpp/f_platform_priority.md b/docs/libraries/concurrency/default_executor.hpp/f_platform_priority.md deleted file mode 100644 index f16e04260..000000000 --- a/docs/libraries/concurrency/default_executor.hpp/f_platform_priority.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -layout: function -title: platform_priority -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/default_executor.hpp -overloads: - constexpr int platform_priority(stlab::detail::executor_priority): - arguments: - - description: __OPTIONAL__ - name: p - type: stlab::detail::executor_priority - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: constexpr int platform_priority(stlab::detail::executor_priority p) -namespace: - - stlab - - v1 - - detail ---- diff --git a/docs/libraries/concurrency/default_executor.hpp/group_t/index.md b/docs/libraries/concurrency/default_executor.hpp/group_t/index.md deleted file mode 100644 index 311b21904..000000000 --- a/docs/libraries/concurrency/default_executor.hpp/group_t/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -layout: class -title: group_t -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/default_executor.hpp -declaration: "\nstruct stlab::detail::group_t;" -ctor: unspecified -fields: - _group: - description: __MISSING__ - type: dispatch_group_t -namespace: - - stlab - - v1 - - detail ---- diff --git a/docs/libraries/concurrency/default_executor.hpp/group_t/m_group_t.md b/docs/libraries/concurrency/default_executor.hpp/group_t/m_group_t.md deleted file mode 100644 index c2022394b..000000000 --- a/docs/libraries/concurrency/default_executor.hpp/group_t/m_group_t.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -layout: method -title: group_t -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/default_executor.hpp -is_ctor: true -overloads: - group_t(): - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: group_t() - group_t(const stlab::detail::group_t &): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const stlab::detail::group_t & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: group_t(const stlab::detail::group_t &) ---- diff --git a/docs/libraries/concurrency/default_executor.hpp/group_t/m_~group_t.md b/docs/libraries/concurrency/default_executor.hpp/group_t/m_~group_t.md deleted file mode 100644 index d9964d2e0..000000000 --- a/docs/libraries/concurrency/default_executor.hpp/group_t/m_~group_t.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -layout: method -title: ~group_t -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/default_executor.hpp -is_dtor: true -overloads: - ~group_t(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~group_t() ---- diff --git a/docs/libraries/concurrency/default_executor.hpp/stlab3A3Av13A3Adetail3A3Aexecutor_priority.md b/docs/libraries/concurrency/default_executor.hpp/stlab3A3Av13A3Adetail3A3Aexecutor_priority.md deleted file mode 100644 index 88217701d..000000000 --- a/docs/libraries/concurrency/default_executor.hpp/stlab3A3Av13A3Adetail3A3Aexecutor_priority.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -layout: enumeration -title: executor_priority -owner: __MISSING__ -brief: __MISSING__ -tags: - - enumeration -defined_in_file: concurrency/default_executor.hpp -namespace: - - stlab - - v1 - - detail -values: - - description: __MISSING__ - name: high - - description: __MISSING__ - name: medium - - description: __MISSING__ - name: low ---- diff --git a/docs/libraries/concurrency/future.hpp/future/f_operator213D.md b/docs/libraries/concurrency/future.hpp/future/f_operator213D.md deleted file mode 100644 index d6b7e107a..000000000 --- a/docs/libraries/concurrency/future.hpp/future/f_operator213D.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -layout: function -title: operator!= -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/future.hpp -overloads: - bool operator!=(const future, void>::type> &, const future, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: const future, void>::type> & - - description: __OPTIONAL__ - name: y - type: const future, void>::type> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator!=(const future, void>::type> & x, const future, void>::type> & y) - bool operator!=(const future, void>::type> &, const future, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: const future, void>::type> & - - description: __OPTIONAL__ - name: y - type: const future, void>::type> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator!=(const future, void>::type> & x, const future, void>::type> & y) - bool operator!=(const stlab::future> &, const stlab::future> &): - arguments: - - description: __OPTIONAL__ - name: x - type: const stlab::future> & - - description: __OPTIONAL__ - name: y - type: const stlab::future> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator!=(const stlab::future> & x, const stlab::future> & y) - bool operator!=(const stlab::future &, const stlab::future &): - arguments: - - description: __OPTIONAL__ - name: x - type: const stlab::future & - - description: __OPTIONAL__ - name: y - type: const stlab::future & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator!=(const stlab::future & x, const stlab::future & y) -namespace: - - stlab - - v1 ---- diff --git a/docs/libraries/concurrency/future.hpp/future/f_operator3D3D.md b/docs/libraries/concurrency/future.hpp/future/f_operator3D3D.md deleted file mode 100644 index a0ead32fe..000000000 --- a/docs/libraries/concurrency/future.hpp/future/f_operator3D3D.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -layout: function -title: operator== -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/future.hpp -overloads: - bool operator==(const future, void>::type> &, const future, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: const future, void>::type> & - - description: __OPTIONAL__ - name: y - type: const future, void>::type> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator==(const future, void>::type> & x, const future, void>::type> & y) - bool operator==(const future, void>::type> &, const future, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: const future, void>::type> & - - description: __OPTIONAL__ - name: y - type: const future, void>::type> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator==(const future, void>::type> & x, const future, void>::type> & y) - bool operator==(const stlab::future> &, const stlab::future> &): - arguments: - - description: __OPTIONAL__ - name: x - type: const stlab::future> & - - description: __OPTIONAL__ - name: y - type: const stlab::future> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator==(const stlab::future> & x, const stlab::future> & y) - bool operator==(const stlab::future &, const stlab::future &): - arguments: - - description: __OPTIONAL__ - name: x - type: const stlab::future & - - description: __OPTIONAL__ - name: y - type: const stlab::future & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator==(const stlab::future & x, const stlab::future & y) -namespace: - - stlab - - v1 ---- diff --git a/docs/libraries/concurrency/future.hpp/future/f_swap.md b/docs/libraries/concurrency/future.hpp/future/f_swap.md deleted file mode 100644 index 208a87582..000000000 --- a/docs/libraries/concurrency/future.hpp/future/f_swap.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -layout: function -title: swap -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/future.hpp -overloads: - void swap(future, void>::type> &, future, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: future, void>::type> & - - description: __OPTIONAL__ - name: y - type: future, void>::type> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: void swap(future, void>::type> & x, future, void>::type> & y) - void swap(future, void>::type> &, future, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: future, void>::type> & - - description: __OPTIONAL__ - name: y - type: future, void>::type> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: void swap(future, void>::type> & x, future, void>::type> & y) - void swap(stlab::future> &, stlab::future> &): - arguments: - - description: __OPTIONAL__ - name: x - type: stlab::future> & - - description: __OPTIONAL__ - name: y - type: stlab::future> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: void swap(stlab::future> & x, stlab::future> & y) - void swap(stlab::future &, stlab::future &): - arguments: - - description: __OPTIONAL__ - name: x - type: stlab::future & - - description: __OPTIONAL__ - name: y - type: stlab::future & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: void swap(stlab::future & x, stlab::future & y) -namespace: - - stlab - - v1 ---- diff --git a/docs/libraries/concurrency/future.hpp/future/index.md b/docs/libraries/concurrency/future.hpp/future/index.md deleted file mode 100644 index 3bf16b0a0..000000000 --- a/docs/libraries/concurrency/future.hpp/future/index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -layout: directory -title: future_error ---- diff --git a/docs/libraries/concurrency/immediate_executor.hpp/immediate_executor_type/index.md b/docs/libraries/concurrency/immediate_executor.hpp/immediate_executor_type/index.md deleted file mode 100644 index 2cda613a0..000000000 --- a/docs/libraries/concurrency/immediate_executor.hpp/immediate_executor_type/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: class -title: immediate_executor_type -owner: sean-parent -brief: Executes tasks immediately -tags: - - class -defined_in_file: concurrency/immediate_executor.hpp -declaration: "\nstruct stlab::detail::immediate_executor_type;" -ctor: unspecified -dtor: unspecified -namespace: - - stlab - - v1 - - detail ---- diff --git a/docs/libraries/concurrency/immediate_executor.hpp/immediate_executor_type/m_operator2829.md b/docs/libraries/concurrency/immediate_executor.hpp/immediate_executor_type/m_operator2829.md deleted file mode 100644 index 510afb3e8..000000000 --- a/docs/libraries/concurrency/immediate_executor.hpp/immediate_executor_type/m_operator2829.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -layout: method -title: operator() -owner: sean-parent -brief: Call operator to schedule a task -tags: - - method -defined_in_file: concurrency/immediate_executor.hpp -overloads: - "template \nvoid operator()(F &&) const": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: The task that shall now be executed. - return: __OPTIONAL__ - signature_with_names: "template \nvoid operator()(F && f) const" - "template \nvoid operator()(std::chrono::steady_clock::time_point, F &&) const": - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: std::chrono::steady_clock::time_point - unnamed: true - - description: __OPTIONAL__ - name: f - type: F && - description: Execute the given task immediately. - return: __OPTIONAL__ - signature_with_names: "template \nvoid operator()(std::chrono::steady_clock::time_point, F && f) const" ---- - -Executes the given function on this executor \ No newline at end of file diff --git a/docs/libraries/concurrency/immediate_executor.hpp/immediate_executor_type/m_~immediate_executor_type.md b/docs/libraries/concurrency/immediate_executor.hpp/immediate_executor_type/m_~immediate_executor_type.md deleted file mode 100644 index 1838e3e34..000000000 --- a/docs/libraries/concurrency/immediate_executor.hpp/immediate_executor_type/m_~immediate_executor_type.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -layout: method -title: ~immediate_executor_type -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/immediate_executor.hpp -is_dtor: true -overloads: - ~immediate_executor_type(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~immediate_executor_type() ---- diff --git a/docs/libraries/concurrency/main_executor.hpp/main_executor_type/index.md b/docs/libraries/concurrency/main_executor.hpp/main_executor_type/index.md deleted file mode 100644 index 2f5ae82c9..000000000 --- a/docs/libraries/concurrency/main_executor.hpp/main_executor_type/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: class -title: main_executor_type -owner: sean-parent -brief: Executes tasks on the application's main loop. -tags: - - class -defined_in_file: concurrency/main_executor.hpp -declaration: "\nstruct stlab::detail::main_executor_type;" -ctor: unspecified -dtor: unspecified -typedefs: - result_type: - definition: void - description: __MISSING__ -namespace: - - stlab - - v1 - - detail ---- - -All tasks that are passed to an instance of this instance are executed in-order on the application's main loop. - -Upon destruction of the main_executor, the underlying main loop is _not_ destroyed. Likewise, all functions submitted to the executor will be executed regardless of destruction state. - -So far no main_executor is implemented for Windows. If `STLAB_MAIN_EXECUTOR` is `qt5` or `qt6`, a main executor is instantiated that executes the tasks on the Qt main loop. \ No newline at end of file diff --git a/docs/libraries/concurrency/main_executor.hpp/main_executor_type/m_operator2829.md b/docs/libraries/concurrency/main_executor.hpp/main_executor_type/m_operator2829.md deleted file mode 100644 index 2a75544e1..000000000 --- a/docs/libraries/concurrency/main_executor.hpp/main_executor_type/m_operator2829.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method -title: operator() -owner: sean-parent -brief: Executes the given function on the application's main loop. -tags: - - method -defined_in_file: concurrency/main_executor.hpp -overloads: - "template \nvoid operator()(F) const": - arguments: - - description: The function object that shall be executed on the main loop. - name: f - type: F - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nvoid operator()(F f) const" ---- diff --git a/docs/libraries/concurrency/system_timer.hpp/system_timer_type/index.md b/docs/libraries/concurrency/system_timer.hpp/system_timer_type/index.md deleted file mode 100644 index 432341ceb..000000000 --- a/docs/libraries/concurrency/system_timer.hpp/system_timer_type/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: class -title: system_timer_type -owner: sean-parent -brief: Executes a function after a specified duration. -tags: - - class -defined_in_file: concurrency/system_timer.hpp -declaration: "\nstruct stlab::detail::system_timer_type;" -ctor: unspecified -dtor: unspecified -typedefs: - result_type: - definition: void - description: __MISSING__ -namespace: - - stlab - - v1 - - detail ---- - -All functions that are passed to an instance of this class are executed after a specified duration. - -`[deprecated]` All functions that are passed to an instance of this class are executed at the specified time. - -Upon destruction of `system_timer`, the underlying main loop is _not_ destroyed. Likewise, all functions submitted to the executor will be executed regardless of destruction state. \ No newline at end of file diff --git a/docs/libraries/concurrency/system_timer.hpp/system_timer_type/m_operator2829.md b/docs/libraries/concurrency/system_timer.hpp/system_timer_type/m_operator2829.md deleted file mode 100644 index 7be65d082..000000000 --- a/docs/libraries/concurrency/system_timer.hpp/system_timer_type/m_operator2829.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: method -title: operator() -owner: sean-parent -brief: Executes the given task after the specified duration. -tags: - - method -defined_in_file: concurrency/system_timer.hpp -overloads: - "template \nvoid operator()(std::chrono::duration, F) const": - arguments: - - description: The waiting duration after the task shall be executed. - name: duration - type: std::chrono::duration - - description: __OPTIONAL__ - name: f - type: F - description: This executors executes the given task after the given duration. - return: __OPTIONAL__ - signature_with_names: "template \nvoid operator()(std::chrono::duration duration, F f) const" - "template \nvoid operator()(std::chrono::steady_clock::time_point, F) const": - annotation: - - deprecated (Use chrono::duration as parameter instead) - arguments: - - description: The time point when the task shall be executed. - name: when - type: std::chrono::steady_clock::time_point - - description: The task that shall be executed on the given executor. - name: f - type: F - description: Executes the given task at the given time. - return: __OPTIONAL__ - signature_with_names: "template \nvoid operator()(std::chrono::steady_clock::time_point when, F f) const" ---- - -Executes the given task after the specified duration. - -[deprecated] Executes the given task at the specified time point. -When the time point is in the past, then the task will be executed immediately. - -In case that the previous task takes longer as the time difference between its starting point and the start of the next task. Then the next task may be executed delayed. So a task can be executed later as specified, but never earlier. \ No newline at end of file diff --git a/docs/libraries/concurrency/system_timer.hpp/system_timer_type/m_~system_timer_type.md b/docs/libraries/concurrency/system_timer.hpp/system_timer_type/m_~system_timer_type.md deleted file mode 100644 index 19facd725..000000000 --- a/docs/libraries/concurrency/system_timer.hpp/system_timer_type/m_~system_timer_type.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -layout: method -title: ~system_timer_type -owner: sean-parent -brief: system_timer_type destructor. -tags: - - method -defined_in_file: concurrency/system_timer.hpp -is_dtor: true -overloads: - ~system_timer_type(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~system_timer_type() ---- diff --git a/docs/libraries/concurrency/task.hpp/f_operator213D.md b/docs/libraries/concurrency/task.hpp/f_operator213D.md deleted file mode 100644 index ac1ae7756..000000000 --- a/docs/libraries/concurrency/task.hpp/f_operator213D.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: function -title: stlab::operator!= -tags: [library] -scope: stlab -pure-name: operator!= -brief: Compares a task for not equal an empty task -description: Compares a task for not equal an empty task -defined-in-header: stlab/concurrency/task.hpp -entities: - - kind: overloads - list: - - name: operator!= - pure-name: operator!= - declaration: | - bool operator!=(const task& x, std::nullptr_t) - description: Checks if the given task `x` is not equal an empty task - - name: operator!= - pure-name: when_all - declaration: | - bool operator!=(std::nullptr_t, const task& x) - description: Checks if the given task `x` is not equal an empty task - - kind: parameters - list: - - name: x - description: The task that shall be compared against an empty task - - kind: result - description: Returns true, if the given task is not equal an empty task. ---- diff --git a/docs/libraries/concurrency/task.hpp/m_operator2829.md b/docs/libraries/concurrency/task.hpp/m_operator2829.md deleted file mode 100644 index c5d5d7d24..000000000 --- a/docs/libraries/concurrency/task.hpp/m_operator2829.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -layout: method -title: stlab::task::operator() -tags: [library] -scope: task -pure-name: operator() -defined-in-header: stlab/concurrency/task.hpp -brief: Invoke the task -entities: - - kind: methods - list: - - name: stlab::task::operator() - pure-name: operator() - defined-in-header: stlab/concurrency/task.hpp - declaration: | - void operator()(Args... args) noexcept - description: Invokes the task - - kind: parameters - list: - - name: args - description: The arguments for calling the stored function. - ---- diff --git a/docs/libraries/concurrency/task.hpp/m_operator3D3D.md b/docs/libraries/concurrency/task.hpp/m_operator3D3D.md deleted file mode 100644 index 24907c49e..000000000 --- a/docs/libraries/concurrency/task.hpp/m_operator3D3D.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: function -title: stlab::operator== -tags: [library] -scope: stlab -pure-name: operator== -brief: Checks if a given task is equal to an empty task -description: Checks if a given task is equal to an empty task -annotation: template function -defined-in-header: stlab/concurrency/task.hpp -entities: - - kind: overloads - list: - - name: operator== - pure-name: operator== - declaration: | - bool operator==(const task& x, std::nullptr_t) - description: Checks if the given task `x` is equal to an empty task - - name: operator== - pure-name: when_all - declaration: | - bool operator==(std::nullptr_t, const task& x) - description: Checks if the given task `x` is equal to an empty task - - kind: parameters - list: - - name: x - description: The task that shall be compared against an empty task - - kind: result - description: Returns true, if the given task is equal to an empty task. ---- diff --git a/docs/libraries/concurrency/task.hpp/m_swap.md b/docs/libraries/concurrency/task.hpp/m_swap.md deleted file mode 100644 index 7642e22de..000000000 --- a/docs/libraries/concurrency/task.hpp/m_swap.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -layout: function -title: stlab::swap -tags: [library] -scope: stlab -pure-name: swap -brief: Exchanges two tasks -description: Exchanges two task -defined-in-header: stlab/concurrency/task.hpp -entities: - - kind: overloads - list: - - name: swap - pure-name: swap - declaration: | - void swap(task& x, task& y) - description: Swaps task x and task y - - kind: parameters - list: - - name: x - description: The one task that shall be exchanged - - name: y - description: The other task that shall be exchanged ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/f_operator213D.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/f_operator213D.md deleted file mode 100644 index d67d0ee0a..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/f_operator213D.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -layout: function -title: operator!= -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/task.hpp -overloads: - bool operator!=(const task &, std::nullptr_t): - arguments: - - description: __OPTIONAL__ - name: x - type: const task & - - description: __OPTIONAL__ - name: unnamed-1 - type: std::nullptr_t - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator!=(const task & x, std::nullptr_t) - bool operator!=(std::nullptr_t, const task &): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: std::nullptr_t - unnamed: true - - description: __OPTIONAL__ - name: x - type: const task & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator!=(std::nullptr_t, const task & x) -namespace: - - stlab - - v1 ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/f_operator3D3D.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/f_operator3D3D.md deleted file mode 100644 index d35fd5938..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/f_operator3D3D.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -layout: function -title: operator== -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/task.hpp -overloads: - bool operator==(const task &, std::nullptr_t): - arguments: - - description: __OPTIONAL__ - name: x - type: const task & - - description: __OPTIONAL__ - name: unnamed-1 - type: std::nullptr_t - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator==(const task & x, std::nullptr_t) - bool operator==(std::nullptr_t, const task &): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: std::nullptr_t - unnamed: true - - description: __OPTIONAL__ - name: x - type: const task & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator==(std::nullptr_t, const task & x) -namespace: - - stlab - - v1 ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/f_swap.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/f_swap.md deleted file mode 100644 index 6776d0c91..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/f_swap.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -layout: function -title: swap -owner: sean-parent -brief: Swaps an other task with this -tags: - - function -defined_in_file: concurrency/task.hpp -overloads: - void swap(task &, task &): - arguments: - - description: __OPTIONAL__ - name: x - type: task & - - description: __OPTIONAL__ - name: y - type: task & - description: Exchanges this task with the passed one. - return: __OPTIONAL__ - signature_with_names: void swap(task & x, task & y) -namespace: - - stlab - - v1 ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/index.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/index.md deleted file mode 100644 index f7019802a..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -layout: class -title: task -owner: sean-parent -brief: General-purpose polymorphic function wrapper. -tags: - - class -defined_in_file: concurrency/task.hpp -declaration: "\nclass stlab::task;" -typedefs: - result_type: - definition: R - description: __MISSING__ -fields: - _invoke: - description: __MISSING__ - type: const stlab::task::invoke_t - _vtable: - description: __MISSING__ - type: const stlab::task::concept_t -namespace: - - stlab - - v1 ---- - -Class template `stlab::task` is a general-purpose polymorphic function wrapper. Instances of `stlab::task` can store, move, and invoke any [Callable](http://en.cppreference.com/w/cpp/named_req/Callable) target -- functions, lambda expressions, bind expressions, or other function objects, as well as pointers to member functions and pointers to data members. - -The stored callable object is called the target of `stlab::task`. If an `stlab::task` contains no target, it is called _empty_. Invoking the target of an empty `stlab::task` results in [`std::bad_function_call`](http://en.cppreference.com/w/cpp/utility/functional/bad_function_call) exception being thrown. - -`stlab::task` is Similar to [`std::function`](http://en.cppreference.com/w/cpp/utility/functional/function) except it is not copyable and supports move-only and mutable callable targets which is especially useful for targets that may only be invoked once, often useful to deliver a message or payload in tasking or messaging system. - -`stlab::task` satisfies the requirements of [MoveConstructible](http://en.cppreference.com/w/cpp/named_req/MoveConstructible) and [MoveAssignable](http://en.cppreference.com/w/cpp/named_req/MoveAssignable). \ No newline at end of file diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_operator20bool.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_operator20bool.md deleted file mode 100644 index 48799c491..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_operator20bool.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -layout: method -title: operator bool -owner: sean-parent -brief: Check if the task can be invoked -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - explicit operator bool() const: - description: Used to determine if the task can be invoked - return: __OPTIONAL__ - signature_with_names: explicit operator bool() const ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_operator2829.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_operator2829.md deleted file mode 100644 index 7c0601530..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_operator2829.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method -title: operator() -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - "template \nauto operator()(Brgs &&...)": - arguments: - - description: __OPTIONAL__ - name: brgs - type: Brgs &&... - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nauto operator()(Brgs &&... brgs)" ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_operator3D.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_operator3D.md deleted file mode 100644 index 3b0c3d9a9..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_operator3D.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -layout: method -title: operator= -owner: sean-parent -brief: Move assignment operator -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - task & operator=(const task &): - annotation: - - delete - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const task & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: task & operator=(const task &) - task & operator=(std::nullptr_t): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: std::nullptr_t - unnamed: true - description: Destroys the current function and creates a new empty one. - return: __OPTIONAL__ - signature_with_names: task & operator=(std::nullptr_t) - task & operator=(task &&): - arguments: - - description: __OPTIONAL__ - name: x - type: task && - description: Moves the given task `x` into `this`. - return: __OPTIONAL__ - signature_with_names: task & operator=(task && x) - "template \ntask & operator=(F &&)": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \ntask & operator=(F && f)" ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_swap.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_swap.md deleted file mode 100644 index e53e65375..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_swap.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method -title: swap -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - void swap(task &): - arguments: - - description: __OPTIONAL__ - name: x - type: task & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void swap(task & x) ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_target.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_target.md deleted file mode 100644 index 8c0293d8e..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_target.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method -title: target -owner: sean-parent -brief: Get the underlying function -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - "template \nT * target()": - description: Mutable variant - return: __OPTIONAL__ - signature_with_names: "template \nT * target()" - "template \nconst T * target() const": - description: Const variant - return: A pointer to the underlying function, if `target_type() == typeid(T)`. Otherwise, `nullptr`. - signature_with_names: "template \nconst T * target() const" ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_target_type.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_target_type.md deleted file mode 100644 index 645d6fcb2..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_target_type.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -layout: method -title: target_type -owner: sean-parent -brief: Get type information about the underlying function -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - const std::type_info & target_type() const: - description: Gives type information about the underlying function - return: __OPTIONAL__ - signature_with_names: const std::type_info & target_type() const ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_task3CR2028Args293E.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_task3CR2028Args293E.md deleted file mode 100644 index e0d4b463e..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_task3CR2028Args293E.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -layout: method -title: task -owner: sean-parent -brief: Constructs an `stlab::task` from a variety of sources. -tags: - - method -defined_in_file: concurrency/task.hpp -is_ctor: true -overloads: - task(): - annotation: - - default - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: task() - task(const task &): - annotation: - - delete - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const task & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: task(const task &) - task(std::nullptr_t): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: std::nullptr_t - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: task(std::nullptr_t) - task(task &&): - arguments: - - description: __OPTIONAL__ - name: x - type: task && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: task(task && x) - "template , task>::value, bool> >\ntask(F &&)": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template , task>::value, bool> >\ntask(F && f)" ---- - -When the target is a function pointer or std::reference_wrapper, small object optimization is -guaranteed, that is, these targets are always directly stored inside the `stlab::task` object, no dynamic allocation takes place. Other large objects may be constructed in dynamic allocated storage and accessed by the `stlab::task` object through a pointer. \ No newline at end of file diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_~task3CR2028Args293E.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_~task3CR2028Args293E.md deleted file mode 100644 index 43f6d1156..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_~task3CR2028Args293E.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -layout: method -title: ~task -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -is_dtor: true -overloads: - ~task(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~task() ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/index.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/index.md deleted file mode 100644 index 78d1e25fc..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -layout: class -title: model -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/task.hpp -declaration: "\nstruct stlab::task::model;" -dtor: unspecified -fields: - _invoke: - description: __MISSING__ - type: const stlab::task::invoke_t - _p: - description: __MISSING__ - type: std::unique_ptr - _vtable: - description: __MISSING__ - type: const stlab::task::concept_t -namespace: - - stlab - - v1 ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_const_pointer.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_const_pointer.md deleted file mode 100644 index 6c2ec25b1..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_const_pointer.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method -title: const_pointer -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static auto const_pointer(const void *) -> const void *: - arguments: - - description: __OPTIONAL__ - name: self - type: const void * - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static auto const_pointer(const void * self) -> const void * ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_dtor.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_dtor.md deleted file mode 100644 index db6500d97..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_dtor.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method -title: dtor -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static void dtor(void *): - arguments: - - description: __OPTIONAL__ - name: self - type: void * - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static void dtor(void * self) ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_invoke.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_invoke.md deleted file mode 100644 index 726118359..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_invoke.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -layout: method -title: invoke -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static auto invoke(void *, Args...) -> R: - arguments: - - description: __OPTIONAL__ - name: self - type: void * - - description: __OPTIONAL__ - name: args - type: Args... - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static auto invoke(void * self, Args... args) -> R ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_model3CF2C20false3E.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_model3CF2C20false3E.md deleted file mode 100644 index d08fbb72b..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_model3CF2C20false3E.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: method -title: model -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -is_ctor: true -overloads: - model(model &&): - annotation: - - default - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: model && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: model(model &&) - "template \nmodel(G &&)": - arguments: - - description: __OPTIONAL__ - name: f - type: G && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nmodel(G && f)" ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_move_ctor.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_move_ctor.md deleted file mode 100644 index 423e7b00b..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_move_ctor.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -layout: method -title: move_ctor -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static void move_ctor(void *, void *): - arguments: - - description: __OPTIONAL__ - name: self - type: void * - - description: __OPTIONAL__ - name: p - type: void * - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static void move_ctor(void * self, void * p) ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_pointer.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_pointer.md deleted file mode 100644 index 87b86d0b7..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_pointer.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method -title: pointer -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static auto pointer(void *) -> void *: - arguments: - - description: __OPTIONAL__ - name: self - type: void * - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static auto pointer(void * self) -> void * ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_target_type.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_target_type.md deleted file mode 100644 index db136860f..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_target_type.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -layout: method -title: target_type -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static auto target_type() -> const std::type_info &: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static auto target_type() -> const std::type_info & ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/index.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/index.md deleted file mode 100644 index ce042eb18..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -layout: class -title: model -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/task.hpp -declaration: "\nstruct stlab::task::model;" -dtor: unspecified -fields: - _f: - description: __MISSING__ - type: F - _invoke: - description: __MISSING__ - type: const stlab::task::invoke_t - _vtable: - description: __MISSING__ - type: const stlab::task::concept_t -namespace: - - stlab - - v1 ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_const_pointer.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_const_pointer.md deleted file mode 100644 index 6c2ec25b1..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_const_pointer.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method -title: const_pointer -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static auto const_pointer(const void *) -> const void *: - arguments: - - description: __OPTIONAL__ - name: self - type: const void * - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static auto const_pointer(const void * self) -> const void * ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_dtor.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_dtor.md deleted file mode 100644 index db6500d97..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_dtor.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method -title: dtor -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static void dtor(void *): - arguments: - - description: __OPTIONAL__ - name: self - type: void * - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static void dtor(void * self) ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_invoke.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_invoke.md deleted file mode 100644 index 726118359..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_invoke.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -layout: method -title: invoke -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static auto invoke(void *, Args...) -> R: - arguments: - - description: __OPTIONAL__ - name: self - type: void * - - description: __OPTIONAL__ - name: args - type: Args... - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static auto invoke(void * self, Args... args) -> R ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_model3CF2C20true3E.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_model3CF2C20true3E.md deleted file mode 100644 index 52d0475e9..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_model3CF2C20true3E.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: method -title: model -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -is_ctor: true -overloads: - model(model &&): - annotation: - - delete - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: model && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: model(model &&) - "template \nmodel(G &&)": - arguments: - - description: __OPTIONAL__ - name: f - type: G && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nmodel(G && f)" ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_move_ctor.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_move_ctor.md deleted file mode 100644 index 423e7b00b..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_move_ctor.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -layout: method -title: move_ctor -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static void move_ctor(void *, void *): - arguments: - - description: __OPTIONAL__ - name: self - type: void * - - description: __OPTIONAL__ - name: p - type: void * - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static void move_ctor(void * self, void * p) ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_pointer.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_pointer.md deleted file mode 100644 index 87b86d0b7..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_pointer.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method -title: pointer -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static auto pointer(void *) -> void *: - arguments: - - description: __OPTIONAL__ - name: self - type: void * - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static auto pointer(void * self) -> void * ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_target_type.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_target_type.md deleted file mode 100644 index db136860f..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_target_type.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -layout: method -title: target_type -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static auto target_type() -> const std::type_info &: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static auto target_type() -> const std::type_info & ---- diff --git a/docs/tips/index.md b/docs/tips/index.md index 16c80db81..eb91d3964 100644 --- a/docs/tips/index.md +++ b/docs/tips/index.md @@ -1,8 +1,9 @@ --- title: Tips layout: page -tab: Tips -icon: thumb-tack +hyde: + tab: Tips + icon: thumb-tack --- From time to time I've posted programming tips (often these have been internal emails), blog posts, or other short form writings. I'm gathering ones that might be of general interest here, updating them in the process. diff --git a/docs/tools/docker-tools/Dockerfile b/docs/tools/docker-tools/Dockerfile index 05c5763f5..0fd1a202e 100644 --- a/docs/tools/docker-tools/Dockerfile +++ b/docs/tools/docker-tools/Dockerfile @@ -69,7 +69,7 @@ RUN (eval "$(rbenv init -)"; \ rbenv install `cat .ruby-version`; \ gem install bundler; \ rbenv rehash; \ - bundle install) + bundle install --frozen) WORKDIR /home/app diff --git a/docs/tools/docker-tools/README.md b/docs/tools/docker-tools/README.md index 60b1444f2..234fb4131 100644 --- a/docs/tools/docker-tools/README.md +++ b/docs/tools/docker-tools/README.md @@ -36,7 +36,7 @@ echo $RUBY_VERSION > ./docs/.ruby-version # build the base image, no-cache is used so the latest tools are installed docker build --build-arg RUBY_VERSION=$RUBY_VERSION --file ./docs/tools/docker-tools/Dockerfile --target base --tag $VOLUME . --no-cache -# update the docs environment +# update the docs environment (see below for using local theme) docker run --mount type=bind,source="$(pwd)",target=/mnt/host --tty --interactive $VOLUME bash ``` @@ -97,7 +97,10 @@ docker ps docker exec -it bash ``` -To test a local copy of the Jekyll theme, edit the Gemfile and use: +To test a local copy of the Jekyll theme + +Edit Gemfile +Edit _config.yml ``` docker run --mount type=bind,source="$(pwd)",target=/mnt/host \