Skip to content

Commit 848ec54

Browse files
automatic update
1 parent cc6e4d4 commit 848ec54

3 files changed

Lines changed: 69 additions & 1 deletion

File tree

docs/getting-started/rust.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ To find the most accurate and complete documentation for Rust please visit https
99
1. Add Velopack to your `Cargo.toml`:
1010
```toml
1111
[dependencies]
12-
velopack = { version = "0.0", features = ["async"] } # Replace with actual version and desired features
12+
velopack = "0.0" # Replace with actual version
1313
```
1414

1515
2. Add the following code to your `main()` function:

docs/reference/cpp/doc_Velopack.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,14 @@
3535

3636
<a href="#standardese-vpkc_update_source_t"><span class="typ dec var fun">vpkc_update_source_t</span></a><span class="pun">*</span> <a href="#standardese-vpkc_new_source_http_url-charconst--"><span class="typ dec var fun">vpkc_new_source_http_url</span></a><span class="pun">(</span><span class="kwd">char</span> <span class="kwd">const</span><span class="pun">*</span> <span class="typ dec var fun">psz_http_url</span><span class="pun">)</span><span class="pun">;</span>
3737

38+
<a href="#standardese-vpkc_update_source_t"><span class="typ dec var fun">vpkc_update_source_t</span></a><span class="pun">*</span> <a href="#standardese-vpkc_new_source_github-charconst--charconst--bool-"><span class="typ dec var fun">vpkc_new_source_github</span></a><span class="pun">(</span><span class="kwd">char</span> <span class="kwd">const</span><span class="pun">*</span> <span class="typ dec var fun">psz_repo_url</span><span class="pun">,</span> <span class="kwd">char</span> <span class="kwd">const</span><span class="pun">*</span> <span class="typ dec var fun">psz_access_token</span><span class="pun">,</span> <span class="kwd">bool</span> <span class="typ dec var fun">b_prerelease</span><span class="pun">)</span><span class="pun">;</span>
39+
40+
<a href="#standardese-vpkc_update_source_t"><span class="typ dec var fun">vpkc_update_source_t</span></a><span class="pun">*</span> <a href="#standardese-vpkc_new_source_gitlab-charconst--charconst--bool-"><span class="typ dec var fun">vpkc_new_source_gitlab</span></a><span class="pun">(</span><span class="kwd">char</span> <span class="kwd">const</span><span class="pun">*</span> <span class="typ dec var fun">psz_repo_url</span><span class="pun">,</span> <span class="kwd">char</span> <span class="kwd">const</span><span class="pun">*</span> <span class="typ dec var fun">psz_access_token</span><span class="pun">,</span> <span class="kwd">bool</span> <span class="typ dec var fun">b_prerelease</span><span class="pun">)</span><span class="pun">;</span>
41+
42+
<a href="#standardese-vpkc_update_source_t"><span class="typ dec var fun">vpkc_update_source_t</span></a><span class="pun">*</span> <a href="#standardese-vpkc_new_source_gitea-charconst--charconst--bool-"><span class="typ dec var fun">vpkc_new_source_gitea</span></a><span class="pun">(</span><span class="kwd">char</span> <span class="kwd">const</span><span class="pun">*</span> <span class="typ dec var fun">psz_repo_url</span><span class="pun">,</span> <span class="kwd">char</span> <span class="kwd">const</span><span class="pun">*</span> <span class="typ dec var fun">psz_access_token</span><span class="pun">,</span> <span class="kwd">bool</span> <span class="typ dec var fun">b_prerelease</span><span class="pun">)</span><span class="pun">;</span>
43+
44+
<a href="#standardese-vpkc_update_source_t"><span class="typ dec var fun">vpkc_update_source_t</span></a><span class="pun">*</span> <a href="#standardese-vpkc_new_source_velopack_flow-charconst--"><span class="typ dec var fun">vpkc_new_source_velopack_flow</span></a><span class="pun">(</span><span class="kwd">char</span> <span class="kwd">const</span><span class="pun">*</span> <span class="typ dec var fun">psz_base_uri</span><span class="pun">)</span><span class="pun">;</span>
45+
3846
<a href="#standardese-vpkc_update_source_t"><span class="typ dec var fun">vpkc_update_source_t</span></a><span class="pun">*</span> <a href="#standardese-vpkc_new_source_custom_callback-vpkc_release_feed_delegate_t-vpkc_free_release_feed_t-vpkc_download_asset_delegate_t-void--"><span class="typ dec var fun">vpkc_new_source_custom_callback</span></a><span class="pun">(</span><a href="#standardese-vpkc_release_feed_delegate_t"><span class="typ dec var fun">vpkc_release_feed_delegate_t</span></a> <span class="typ dec var fun">cb_release_feed</span><span class="pun">,</span> <a href="#standardese-vpkc_free_release_feed_t"><span class="typ dec var fun">vpkc_free_release_feed_t</span></a> <span class="typ dec var fun">cb_free_release_feed</span><span class="pun">,</span> <a href="#standardese-vpkc_download_asset_delegate_t"><span class="typ dec var fun">vpkc_download_asset_delegate_t</span></a> <span class="typ dec var fun">cb_download_entry</span><span class="pun">,</span> <span class="kwd">void</span><span class="pun">*</span> <span class="typ dec var fun">p_user_data</span><span class="pun">)</span><span class="pun">;</span>
3947

4048
<span class="kwd">void</span> <a href="#standardese-vpkc_source_report_progress-size_t-int16_t-"><span class="typ dec var fun">vpkc_source_report_progress</span></a><span class="pun">(</span><span class="typ dec var fun">size_t</span> <span class="typ dec var fun">progress_callback_id</span><span class="pun">,</span> <span class="typ dec var fun">int16_t</span> <span class="typ dec var fun">progress</span><span class="pun">)</span><span class="pun">;</span>
@@ -401,6 +409,58 @@ Create a new HttpSource update source for a given HTTP URL.
401409

402410
-----
403411

412+
## Function `vpkc_new_source_github`
413+
414+
<span id="standardese-vpkc_new_source_github-charconst--charconst--bool-"></span>
415+
416+
<pre><code class="standardese-language-cpp"><a href="#standardese-vpkc_update_source_t"><span class="typ dec var fun">vpkc_update_source_t</span></a><span class="pun">*</span> <span class="typ dec var fun">vpkc_new_source_github</span><span class="pun">(</span><span class="kwd">char</span> <span class="kwd">const</span><span class="pun">*</span> <span class="typ dec var fun">psz_repo_url</span><span class="pun">,</span> <span class="kwd">char</span> <span class="kwd">const</span><span class="pun">*</span> <span class="typ dec var fun">psz_access_token</span><span class="pun">,</span> <span class="kwd">bool</span> <span class="typ dec var fun">b_prerelease</span><span class="pun">)</span><span class="pun">;</span>
417+
</code></pre>
418+
419+
Create a new GithubSource update source for a GitHub repository.
420+
421+
@param psz\_repo\_url The GitHub repository URL (e.g. “https://github.com/user/repo”). @param psz\_access\_token Optional access token for private repositories (can be null). @param b\_prerelease Whether to include pre-release versions. @returns A new vpkc\_update\_source\_t instance, or null on error.
422+
423+
-----
424+
425+
## Function `vpkc_new_source_gitlab`
426+
427+
<span id="standardese-vpkc_new_source_gitlab-charconst--charconst--bool-"></span>
428+
429+
<pre><code class="standardese-language-cpp"><a href="#standardese-vpkc_update_source_t"><span class="typ dec var fun">vpkc_update_source_t</span></a><span class="pun">*</span> <span class="typ dec var fun">vpkc_new_source_gitlab</span><span class="pun">(</span><span class="kwd">char</span> <span class="kwd">const</span><span class="pun">*</span> <span class="typ dec var fun">psz_repo_url</span><span class="pun">,</span> <span class="kwd">char</span> <span class="kwd">const</span><span class="pun">*</span> <span class="typ dec var fun">psz_access_token</span><span class="pun">,</span> <span class="kwd">bool</span> <span class="typ dec var fun">b_prerelease</span><span class="pun">)</span><span class="pun">;</span>
430+
</code></pre>
431+
432+
Create a new GitlabSource update source for a GitLab repository.
433+
434+
@param psz\_repo\_url The GitLab repository URL (e.g. “https://gitlab.com/user/repo”). @param psz\_access\_token Optional access token for private repositories (can be null). @param b\_prerelease Whether to include pre-release versions. @returns A new vpkc\_update\_source\_t instance, or null on error.
435+
436+
-----
437+
438+
## Function `vpkc_new_source_gitea`
439+
440+
<span id="standardese-vpkc_new_source_gitea-charconst--charconst--bool-"></span>
441+
442+
<pre><code class="standardese-language-cpp"><a href="#standardese-vpkc_update_source_t"><span class="typ dec var fun">vpkc_update_source_t</span></a><span class="pun">*</span> <span class="typ dec var fun">vpkc_new_source_gitea</span><span class="pun">(</span><span class="kwd">char</span> <span class="kwd">const</span><span class="pun">*</span> <span class="typ dec var fun">psz_repo_url</span><span class="pun">,</span> <span class="kwd">char</span> <span class="kwd">const</span><span class="pun">*</span> <span class="typ dec var fun">psz_access_token</span><span class="pun">,</span> <span class="kwd">bool</span> <span class="typ dec var fun">b_prerelease</span><span class="pun">)</span><span class="pun">;</span>
443+
</code></pre>
444+
445+
Create a new GiteaSource update source for a Gitea repository.
446+
447+
@param psz\_repo\_url The Gitea repository URL (e.g. “https://gitea.example.com/user/repo”). @param psz\_access\_token Optional access token for private repositories (can be null). @param b\_prerelease Whether to include pre-release versions. @returns A new vpkc\_update\_source\_t instance, or null on error.
448+
449+
-----
450+
451+
## Function `vpkc_new_source_velopack_flow`
452+
453+
<span id="standardese-vpkc_new_source_velopack_flow-charconst--"></span>
454+
455+
<pre><code class="standardese-language-cpp"><a href="#standardese-vpkc_update_source_t"><span class="typ dec var fun">vpkc_update_source_t</span></a><span class="pun">*</span> <span class="typ dec var fun">vpkc_new_source_velopack_flow</span><span class="pun">(</span><span class="kwd">char</span> <span class="kwd">const</span><span class="pun">*</span> <span class="typ dec var fun">psz_base_uri</span><span class="pun">)</span><span class="pun">;</span>
456+
</code></pre>
457+
458+
Create a new VelopackFlowSource update source for Velopack Flow.
459+
460+
@param psz\_base\_uri Optional base URI for the Velopack Flow API (can be null for default). @returns A new vpkc\_update\_source\_t instance, or null on error.
461+
462+
-----
463+
404464
## Function `vpkc_new_source_custom_callback`
405465

406466
<span id="standardese-vpkc_new_source_custom_callback-vpkc_release_feed_delegate_t-vpkc_free_release_feed_t-vpkc_download_asset_delegate_t-void--"></span>

docs/reference/cpp/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,16 @@ sidebar_position: 0
6060

6161
- [`vpkc_new_source_file`](doc_Velopack.md#standardese-vpkc_new_source_file-charconst--) &mdash; Create a new FileSource update source for a given file path.
6262

63+
- [`vpkc_new_source_gitea`](doc_Velopack.md#standardese-vpkc_new_source_gitea-charconst--charconst--bool-) &mdash; Create a new GiteaSource update source for a Gitea repository.
64+
65+
- [`vpkc_new_source_github`](doc_Velopack.md#standardese-vpkc_new_source_github-charconst--charconst--bool-) &mdash; Create a new GithubSource update source for a GitHub repository.
66+
67+
- [`vpkc_new_source_gitlab`](doc_Velopack.md#standardese-vpkc_new_source_gitlab-charconst--charconst--bool-) &mdash; Create a new GitlabSource update source for a GitLab repository.
68+
6369
- [`vpkc_new_source_http_url`](doc_Velopack.md#standardese-vpkc_new_source_http_url-charconst--) &mdash; Create a new HttpSource update source for a given HTTP URL.
6470

71+
- [`vpkc_new_source_velopack_flow`](doc_Velopack.md#standardese-vpkc_new_source_velopack_flow-charconst--) &mdash; Create a new VelopackFlowSource update source for Velopack Flow.
72+
6573
- [`vpkc_new_update_manager`](doc_Velopack.md#standardese-vpkc_new_update_manager-charconst--vpkc_update_options_t--vpkc_locator_config_t--vpkc_update_manager_t---) &mdash; Create a new UpdateManager instance.
6674

6775
- [`vpkc_new_update_manager_with_source`](doc_Velopack.md#standardese-vpkc_new_update_manager_with_source-vpkc_update_source_t--vpkc_update_options_t--vpkc_locator_config_t--vpkc_update_manager_t---) &mdash; Create a new UpdateManager instance with a custom UpdateSource.

0 commit comments

Comments
 (0)