### Jass Doc Annotation Example - Multi-line Note with Link

Source: https://github.com/lep/jassdoc/blob/master/Readme.md

Shows an example of a Jass Doc comment with a multi-line note that includes a hyperlink, demonstrating how to incorporate external references within the documentation.

```jass
/**
@note
Same as above, but on the next line, with a [link](http://example.com/function-discussion)
*/
```

--------------------------------

### Jass Doc Annotation Example - Short Description

Source: https://github.com/lep/jassdoc/blob/master/Readme.md

Illustrates how to write a concise Jass Doc comment with a single-line description and a note, demonstrating the flexibility of the annotation system for brief documentation.

```jass
/**
@note one line. This word will be in **bold**
*/
```

--------------------------------

### Build Project with Nix

Source: https://github.com/lep/jassdoc/blob/master/Readme.md

Instructions on how to build the jassdoc project using Nix flakes, requiring a Nix/Nixos installation. This command leverages the provided flake file for reproducible builds.

```bash
nix build github:lep/jassdoc
```

--------------------------------

### Build Project with Make

Source: https://github.com/lep/jassdoc/blob/master/Readme.md

Instructions on how to build the jass.db project using the 'make' command, assuming a GHC, cabal, gnu make, and sqlite3 CLI binary are installed. This is the manual build process.

```bash
make
```

--------------------------------

### Jass Doc Annotation Example - CripplePlayer

Source: https://github.com/lep/jassdoc/blob/master/Readme.md

An example demonstrating the Jass Doc annotation format for documenting a JASS native function, including general description, notes, parameters, and return types. It highlights the use of Markdown within the comments.

```jass
/**
Reveals a player's remaining buildings to a force. The black mask over the
buildings will be removed as if the territory had been discovered

@note This function will not check whether the player has a town hall before revealing.

@param whichPlayer The player to reveal.

@param toWhichPlayers The players who will see whichPlayer's buildings.

@param flag If true, the buildings will be revealed. If false, the buildings
will not be revealed. Note that if you set it to false, it will not hide the buildings with a black mask.
*/
native CripplePlayer takes player whichPlayer, force toWhichPlayers, boolean flag returns nothing
```

--------------------------------

### Extract luahelper.lua Automatically (Bash)

Source: https://github.com/lep/jassdoc/blob/master/extra-lua/README.md

This snippet demonstrates the automatic extraction of the luahelper.lua file. It requires setting the Warcraft III executable path and running an extraction script. A Lua interpreter must be installed.

```bash
export w3exe="$(cygpath 'D:\SteamLibrary\Warcraft III\_retail_\x86_64\Warcraft III.exe')"
lua "extract-luahelper.lua" --luahelper "$w3exe" --no-debug > output-luahelper.lua
```

--------------------------------

### Jass Doc Copy-Paste Template

Source: https://github.com/lep/jassdoc/blob/master/Readme.md

A general template for writing Jass Doc comments, providing placeholders for various annotations like general description, parameters, bugs, notes, and other tags, intended to facilitate new documentation contributions.

```jass
/**
GENERAL_DESCRIPTION

@param VARIABLE_1_NAME VARIABLE_1_EXPLANATION

@bug DESCRIBE_BUGGY_BEHAVIOUR_IF_ANY

@note ADD_YOUR_CUSTOM_NOTE

@async / @event EVENT_NAME / @patch PATCH_VERSION
*/
```

--------------------------------

### Extract luahelper.lua Manually (Bash)

Source: https://github.com/lep/jassdoc/blob/master/extra-lua/README.md

This snippet illustrates the manual extraction of Lua helper data from the Warcraft III executable. It involves using command-line utilities like `strings` and `grep`. This method is useful for inspecting the executable's contents directly.

```bash
export w3exe="$(cygpath 'D:\SteamLibrary\Warcraft III\_retail_\x86_64\Warcraft III.exe')"
strings --data -n 8 -t d "$w3exe" | grep -C2 --color -i __jarray
tail --bytes +12345 "$w3exe" | strings -n 1 | head -n 80
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.