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.

Sign up for GitHub

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

Jump to bottom

Add documentation for some API server functions #14

Merged
merged 4 commits into from
Feb 18, 2019
Merged

Add documentation for some API server functions #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4b8ddb5
Add documentation for some API server functions
The-Noah Feb 15, 2019
a7dd584
Update _documentation/developer/bzfs_api_functions/bz_loadPlugin.md
allejo Feb 16, 2019
7d51626
Update bz_APIVersion.md
The-Noah Feb 16, 2019
31bbabc
Update _documentation/developer/bzfs_api_functions/bz_APIVersion.md
allejo Feb 17, 2019
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
6 changes: 4 additions & 2 deletions _documentation/developer/bzfs_api_functions/bz_APIVersion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ signatures:
- []
returns:
dataType: int
description: ~
description: BZAPI version.
---

This function needs a description. Please feel free to contribute a description to this function.
The internal API version is used by bzfs so it can safely fail to load plugins that were compiled with older versions of bzfs that had a different API version. This value is only changed during protocol breaks or when something changes in the API such as the signature for an existing function or properties of API objects.

Most plug-ins won't have the need to make use of this information.
6 changes: 3 additions & 3 deletions _documentation/developer/bzfs_api_functions/bz_MD5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ category: String Operations
signatures:
- - dataType: const char*
name: str
description: ~
description: String to be hashed.
default: ~
returns:
dataType: const char*
description: ~
description: The MD5 hash of `str`.
---

This function needs a description. Please feel free to contribute a description to this function.
Creates an MD5 hash of the `str` argument provided.
4 changes: 2 additions & 2 deletions _documentation/developer/bzfs_api_functions/bz_getProtocolVersion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ signatures:
- []
returns:
dataType: const char*
description: ~
description: The protocol version.
---

This function needs a description. Please feel free to contribute a description to this function.
Returns BZFlag protocol version. Example: `0221`.
4 changes: 2 additions & 2 deletions _documentation/developer/bzfs_api_functions/bz_getServerVersion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ signatures:
- []
returns:
dataType: const char*
description: ~
description: The protocol version with "BZFS" added to the front.
---

This function needs a description. Please feel free to contribute a description to this function.
Returns the server's protocol version. Example: `BZFS0221`.
8 changes: 4 additions & 4 deletions _documentation/developer/bzfs_api_functions/bz_loadPlugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ category: Plug-in Management
signatures:
- - dataType: const char*
name: path
description: ~
description: Path to the plug-in to be loaded.
default: ~
- dataType: const char*
name: params
description: ~
description: Parameters to be passed to the plug-in.
default: ~
returns:
dataType: bool
description: ~
description: `true` if it succeeded, otherwise `false`.
---

This function needs a description. Please feel free to contribute a description to this function.
Loads a plug-in based on arguments provided.
6 changes: 3 additions & 3 deletions _documentation/developer/bzfs_api_functions/bz_unloadPlugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ category: Plug-in Management
signatures:
- - dataType: const char*
name: path
description: ~
description: Path to the plug-in to be unloaded.
default: ~
returns:
dataType: bool
description: ~
description: `true` if it succeeded, `false` if it didn't.
---

This function needs a description. Please feel free to contribute a description to this function.
Unloads a plug-in based on arguments provided.