1 # Coding and Documentation Style
3 [Error Logging](#error-logging)
4 [GPL header](#gpl-header)
5 [Git change log](#git-change-log)
6 [Source Code Style](#source-code-style)
7 [External Software Tools](#external-software-tools)
8 [Geeqie Software Tools](#geeqie-software-tools)
9 [Documentation](#documentation)
10 [Documentation - C code](#c-code)
11 [Documentation - Script files](#script-files)
20 Use `DEBUG_0()` only for temporary debugging i.e. not in code in the repository.
21 The user will then not see irrelevant debug output when the default
22 `debug level = 0` is used.
26 If the first word of the message is "error" or "warning" (case insensitive) the message will be color-coded appropriately.
28 - Note that these messages are output in the idle loop.
32 `print_term(gboolean err, const gchar *text_utf8)`
34 - If `err` is TRUE output is to STDERR, otherwise to STDOUT
36 ### DEBUG_NAME(widget)
38 For use with the [GTKInspector](https://wiki.gnome.org/action/show/Projects/GTK/Inspector?action=show&redirect=Projects%2FGTK%2B%2FInspector) to provide a visual indication of where objects are declared.
40 Sample command line call:
41 `GTK_DEBUG=interactive src/geeqie`
47 Include a header in every file, like this:
51 * Copyright (C) <year> The Geeqie Team
56 * This program is free software; you can redistribute it and/or modify
57 * it under the terms of the GNU General Public License as published by
58 * the Free Software Foundation; either version 2 of the License, or
59 * (at your option) any later version.
61 * This program is distributed in the hope that it will be useful,
62 * but WITHOUT ANY WARRANTY; without even the implied warranty of
63 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
64 * GNU General Public License for more details.
66 * You should have received a copy of the GNU General Public License along
67 * with this program; if not, write to the Free Software Foundation, Inc.,
68 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
71 * Optional description of purpose of file.
80 If referencing a Geeqie GitHub issue, include the issue number in the summary line and a hyperlink to the GitHub issue webpage in the message body. Start with a short summary in the first line (without a dot at the end) followed by a empty line.
82 Use whole sentences beginning with Capital letter. For each modification use a new line. Or you can write the theme, colon and then every change on new line, begin with "- ".
84 See also [A Note About Git Commit Messages](http://www.tpope.net/node/106)
91 There was the bug that something was wrong. I fixed it.
94 - the interface was modified
95 - new functions were added`
98 Also please use your full name and a working e-mail address as author for any contribution.
104 Indentation: tabs at 4 spaces
108 - of variables & functions: small\_letters
109 - of defines: CAPITAL\_LETTERS
111 Try to use explicit variable and function names.
112 Try not to use macros.
113 Use **either** "struct foo" OR "foo"; never both
131 if (<cond_very_very_very_very_very_very_very_very_very_long> &&
132 <cond2very_very_very_very_very_very_very_very_very_long>)
145 for (i = 0; i <= 10; i++)
156 gint bar(<var_def>, <var_def>, <var_def>)
162 return 0; // i.e. SUCCESS; if error, you must return minus <err_no> @FIXME
173 Pragma: (Indentation 2 spaces)
178 # define _(String) (String)
179 #endif /* ENABLE_NLS */
188 Use spaces around every operator (except `.`, `->`, `++` and `--`).
189 Unary operator `*` and `&` are missing the space from right, (and also unary `-`).
191 As you can see above, parentheses are closed to inside, i.e. ` (blah blah) `
192 In `function(<var>)` there is no space before the `(`.
193 You *may* use more tabs/spaces than you *ought to* (according to this CodingStyle), if it makes your code nicer in being vertically indented.
194 Variables declarations should be followed by a blank line and should always be at the start of the block.
196 Use glib types when possible (ie. gint and gchar instead of int and char).
197 Use glib functions when possible (i.e. `g_ascii_isspace()` instead of `isspace()`).
198 Check if used functions are not deprecated.
201 ## External Software Tools
205 There is no code format program that exactly matches the above style, but if you are writing new code the following command line program formats code to a fairly close level:
208 astyle --options=<options file>
211 Where the options file might contain:
225 A lint-style program may be used, e.g.
228 cppcheck --language=c --library=gtk --enable=all --force -USA_SIGINFO -UZD_EXPORT -Ugettext_noop -DG_KEY_FILE_DESKTOP_GROUP --template=gcc -I .. --quiet --suppressions-list=<suppressions file>
231 Where the suppressions file might contain:
242 Markdown documents may be validated with e.g. [markdownlint](https://github.com/markdownlint/markdownlint).
245 mdl --style <style file>`
248 Where the style file might contain:
252 rule 'MD007', :indent => 4
253 rule 'MD009', :br_spaces => 2
254 rule 'MD010', :code_blocks => true
260 Shell scripts may also be validated, e.g.
263 shellcheck --enable=add-default-case,avoid-nullary-conditions,check-unassigned-uppercase,deprecate-which,quote-safe-variables
268 The .xml Help files may be validated with e.g. `xmllint`.
272 ## Geeqie Software Tools
274 See the shell scripts section in the Doxygen documentation (`File List`, `detail level 3`, except the `src` sublist).
280 Use American, rather than British English, spelling. This will facilitate consistent
281 text searches. User text may be translated via the en_GB.po file.
283 To document the code use the following rules to allow extraction with Doxygen.
284 Not all comments have to be Doxygen comments.
288 - Use C comments in plain C files and use C++ comments in C++ files for one line comments.
289 - Use `/**` (note the two asterisks) to start comments to be extracted by Doxygen and start every following line with ` *` as shown below.
290 - Use `@` to indicate Doxygen keywords/commands (see below).
291 - Use the `@deprecated` command to indicate the function is subject to be deleted or to a complete rewrite.
293 To document functions or big structures:
297 * @brief This is a short description of the function.
299 * This function does ...
301 * @param x1 This is the first parameter named x1
302 * @param y1 This is the second parameter named y1
303 * @return What the function returns
304 * You can extend that return description (or anything else) by indenting the
305 * following lines until the next empty line or the next keyword/command.
306 * @see Cross reference
310 To document members of a structure that have to be documented (use it at least
311 for big structures) use the `/**<` format:
314 gint counter; /**< This counter counts images */
318 Document TODO or FIXME comments as:
334 Script files such as .sh, .pl, and .awk should have the file relevant file extension or be symlinked as so.
336 Doxygen comments should start each line with `##`, and each file should contain:
340 ## @brief <one line description>
341 ## <contents description>
347 For further documentation about Doxygen see the [Doxygen Manual](https://www.doxygen.nl/index.html).
348 For the possible commands you may use, see [Doxygen Special Commands](https://www.doxygen.nl/manual/commands.html).
350 The file `./scripts/doxygen-help.sh` may be used to integrate access to the Doxygen files into a code editor.
352 The following environment variables may be set to personalize the Doxygen output:
355 DOCDIR=<output folder>
356 SRCDIR=<the top level directory of the project>
360 INLINE_SOURCES=<YES|NO>
361 STRIP_CODE_COMMENTS=<YES|NO>
364 Ref: [INLINE\_SOURCES](https://www.doxygen.nl/manual/config.html#cfg_inline_sources)
365 Ref: [STRIP\_CODE\_COMMENTS](https://www.doxygen.nl/manual/config.html#cfg_strip_code_comments)
367 For shell scripts to be documented, the file `doxygen-bash.sed` must be in the `$PATH` environment variable.
368 It can be download from here:
371 wget https://raw.githubusercontent.com/Anvil/bash-doxygen/master/doxygen-bash.sed
372 chmod +x doxygen-bash.sed
375 To include diagrams in the Doxygen output, the following are required to be installed. The installation process will vary between distributions:
377 [The PlantUML jar](https://plantuml.com/download)
380 sudo apt install default-jre
381 sudo apt install texlive-font-utils
386 But in case just think about that the documentation is for other developers not
387 for the end user. So keep the focus.