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)
12 [Documentation - Markdown](#markdown)
21 Use `DEBUG_0()` only for temporary debugging i.e. not in code in the repository.
22 The user will then not see irrelevant debug output when the default
23 `debug level = 0` is used.
27 If the first word of the message is "error" or "warning" (case insensitive) the message will be color-coded appropriately.
29 - Note that these messages are output in the idle loop.
33 `print_term(gboolean err, const gchar *text_utf8)`
35 - If `err` is TRUE output is to STDERR, otherwise to STDOUT
37 ### DEBUG_NAME(widget)
39 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.
41 Sample command line call:
42 `GTK_DEBUG=interactive src/geeqie`
48 Include a header in every file, like this:
52 * Copyright (C) <year> The Geeqie Team
57 * This program is free software; you can redistribute it and/or modify
58 * it under the terms of the GNU General Public License as published by
59 * the Free Software Foundation; either version 2 of the License, or
60 * (at your option) any later version.
62 * This program is distributed in the hope that it will be useful,
63 * but WITHOUT ANY WARRANTY; without even the implied warranty of
64 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
65 * GNU General Public License for more details.
67 * You should have received a copy of the GNU General Public License along
68 * with this program; if not, write to the Free Software Foundation, Inc.,
69 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
72 * Optional description of purpose of file.
81 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.
83 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 "- ".
85 See also [A Note About Git Commit Messages](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
92 There was the bug that something was wrong. I fixed it.
95 - the interface was modified
96 - new functions were added`
99 Also please use your full name and a working e-mail address as author for any contribution.
105 Indentation: tabs at 4 spaces
109 - of variables & functions: small\_letters
110 - of defines: CAPITAL\_LETTERS
112 Try to use explicit variable and function names.
113 Try not to use macros.
114 Use **either** "struct foo" OR "foo"; never both
132 if (<cond_very_very_very_very_very_very_very_very_very_long> &&
133 <cond2very_very_very_very_very_very_very_very_very_long>)
146 for (i = 0; i <= 10; i++)
157 gint bar(<var_def>, <var_def>, <var_def>)
163 return 0; // i.e. SUCCESS; if error, you must return minus <err_no> @FIXME
174 Pragma: (Indentation 2 spaces)
179 # define _(String) (String)
180 #endif /* ENABLE_NLS */
189 Use spaces around every operator (except `.`, `->`, `++` and `--`).
190 Unary operator `*` and `&` are missing the space from right, (and also unary `-`).
192 As you can see above, parentheses are closed to inside, i.e. ` (blah blah) `
193 In `function(<var>)` there is no space before the `(`.
194 You *may* use more tabs/spaces than you *ought to* (according to this CodingStyle), if it makes your code nicer in being vertically indented.
195 Variables declarations should be followed by a blank line and should always be at the start of the block.
197 Use glib types when possible (ie. gint and gchar instead of int and char).
198 Use glib functions when possible (i.e. `g_ascii_isspace()` instead of `isspace()`).
199 Check if used functions are not deprecated.
202 ## External Software Tools
206 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:
209 astyle --options=<options file>
212 Where the options file might contain:
226 A lint-style program may be used, e.g.
229 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>
232 Where the suppressions file might contain:
243 Markdown documents may be validated with e.g. [markdownlint](https://github.com/markdownlint/markdownlint).
246 mdl --style <style file>`
249 Where the style file might contain:
253 rule 'MD007', :indent => 4
254 rule 'MD009', :br_spaces => 2
255 rule 'MD010', :code_blocks => true
261 Shell scripts may also be validated, e.g.
264 shellcheck --enable=add-default-case,avoid-nullary-conditions,check-unassigned-uppercase,deprecate-which,quote-safe-variables
269 The .xml Help files may be validated with e.g. `xmllint`.
273 ## Geeqie Software Tools
275 See the shell scripts section in the Doxygen documentation (`File List`, `detail level 3`, except the `src` sublist).
281 Use American, rather than British English, spelling. This will facilitate consistent
282 text searches. User text may be translated via the en_GB.po file.
284 To document the code use the following rules to allow extraction with Doxygen.
285 Not all comments have to be Doxygen comments.
289 - Use C comments in plain C files and use C++ comments in C++ files for one line comments.
290 - Use `/**` (note the two asterisks) to start comments to be extracted by Doxygen and start every following line with ` *` as shown below.
291 - Use `@` to indicate Doxygen keywords/commands (see below).
292 - Use the `@deprecated` command to indicate the function is subject to be deleted or to a complete rewrite.
294 To document functions or big structures:
298 * @brief This is a short description of the function.
300 * This function does ...
302 * @param x1 This is the first parameter named x1
303 * @param y1 This is the second parameter named y1
304 * @return What the function returns
305 * You can extend that return description (or anything else) by indenting the
306 * following lines until the next empty line or the next keyword/command.
307 * @see Cross reference
311 To document members of a structure that have to be documented (use it at least
312 for big structures) use the `/**<` format:
315 gint counter; /**< This counter counts images */
319 Document TODO or FIXME comments as:
335 Script files such as .sh, .pl, and .awk should have the file relevant file extension or be symlinked as so.
337 Doxygen comments should start each line with `##`, and each file should contain:
341 ## @brief <one line description>
342 ## <contents description>
348 For a newline use two spaces (a backslash is not interpreted correctly by Doxygen).
352 For further documentation about Doxygen see the [Doxygen Manual](https://www.doxygen.nl/index.html).
353 For the possible commands you may use, see [Doxygen Special Commands](https://www.doxygen.nl/manual/commands.html).
355 The file `./scripts/doxygen-help.sh` may be used to integrate access to the Doxygen files into a code editor.
357 The following environment variables may be set to personalize the Doxygen output:
360 DOCDIR=<output folder>
361 SRCDIR=<the top level directory of the project>
365 INLINE_SOURCES=<YES|NO>
366 STRIP_CODE_COMMENTS=<YES|NO>
369 Ref: [INLINE\_SOURCES](https://www.doxygen.nl/manual/config.html#cfg_inline_sources)
370 Ref: [STRIP\_CODE\_COMMENTS](https://www.doxygen.nl/manual/config.html#cfg_strip_code_comments)
372 For shell scripts to be documented, the file `doxygen-bash.sed` must be in the `$PATH` environment variable.
373 It can be download from here:
376 wget https://raw.githubusercontent.com/Anvil/bash-doxygen/master/doxygen-bash.sed
377 chmod +x doxygen-bash.sed
380 To include diagrams in the Doxygen output, the following are required to be installed. The installation process will vary between distributions:
382 [The PlantUML jar](https://plantuml.com/download)
385 sudo apt install default-jre
386 sudo apt install texlive-font-utils
391 But in case just think about that the documentation is for other developers not
392 for the end user. So keep the focus.