diff options
| author |  Kurtis Rader <krader@skepticism.us> | 2016-04-19 18:17:39 -0700 |
|---|---|---|
| committer | Kurtis Rader <krader@skepticism.us> | 2016-04-19 18:22:44 -0700 |
| commit | bd4622a0d01c7d882c37c46f6730567750dda657 (patch) | |
| tree | 34ad2fb70a5a7db8ac52d417b6d9905e42ad1aab /CONTRIBUTING.md | |
| parent | 9aeed0dc06c4dc9b23701e56b62e9aa9de6e81d5 (diff) | |
make comments Xcode friendly
The OS X Xcode IDE has a weird requirement that block comments preceding a
function or class definition must begin with three slashes rather than two if
you want the comment displayed in the "Quick Help" window.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e73bc344..8e610b13 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -84,6 +84,8 @@ The first word of global variable names should generally be `fish` for public va 1. Comments should always use the C++ style; i.e., each line of the comment should begin with a `//` and should be limited to 100 characters. Comments that do not begin a line should be separated from the previous text by two spaces. +1. Comments that document the purpose of a function or class should begin with three slashes, `///`, so that OS X Xcode (and possibly other ideas) will extract the comment and show it in the "Quick Help" window when the cursor is on the symbol. + ## Testing The source code for fish includes a large collection of tests. If you are making any changes to fish, running these tests is highly recommended to make sure the behaviour remains consistent. |