Use gdk_rectangle_intersect() in pan-view

[geeqie.git] / CODING.md

diff --git a/CODING.md b/CODING.md
index e33bcdf..4f4d492 100644 (file)
--- a/CODING.md
+++ b/CODING.md
@@ -42,6 +42,22 @@ For use with the [GTKInspector](https://wiki.gnome.org/action/show/Projects/GTK/
 Sample command line call:  
 `GTK_DEBUG=interactive src/geeqie`
 
 Sample command line call:  
 `GTK_DEBUG=interactive src/geeqie`
 

+### DEBUG_BT()
+
+Prints a backtrace.
+Use only for temporary debugging i.e. not in code in the repository
+
+### DEBUG_FD()
+
+Prints a dump of the FileData hash list as a ref. count followed by the full path of the item.
+Use only for temporary debugging i.e. not in code in the repository
+
+### Log Window
+
+When the Log Window has focus, the F1 key executes the action specified in `Edit/Preferences/Behavior/Log Window F1 Command` with the selected text as a parameter.
+If no text is selected, the entire line is passed to the command.
+This feature may be used to open an editor at a file location in the text string.
+

 ---
 
 ## GPL header
 ---
 
 ## GPL header


@@ -187,6 +203,8 @@ Headers:
 #ifndef _FILENAME_H
 ```
 
 #ifndef _FILENAME_H
 ```
 

+Use [Names and Order of Includes](https://google.github.io/styleguide/cppguide.html#Names_and_Order_of_Includes) for headers include order.
+

 Use spaces around every operator (except `.`, `->`, `++` and `--`).  
 Unary operator `*` and `&` are missing the space from right, (and also unary `-`).
 
 Use spaces around every operator (except `.`, `->`, `++` and `--`).  
 Unary operator `*` and `&` are missing the space from right, (and also unary `-`).
 


@@ -197,7 +215,7 @@ Variables declarations should be followed by a blank line and should always be a
 
 Use glib types when possible (ie. gint and gchar instead of int and char).  
 Use glib functions when possible (i.e. `g_ascii_isspace()` instead of `isspace()`).  
 
 Use glib types when possible (ie. gint and gchar instead of int and char).  
 Use glib functions when possible (i.e. `g_ascii_isspace()` instead of `isspace()`).  

-Check if used functions are not deprecated.
+Check if used functions are not deprecated.  

 
 ---
 
 
 ---
 


@@ -219,6 +237,7 @@ mktemp  "${TMPDIR:-/tmp}/geeqie.XXXXXXXXXX"
 ```
 
 ---
 ```
 
 ---

+

 ## External Software Tools
 
 ### astyle
 ## External Software Tools
 
 ### astyle


@@ -331,6 +350,8 @@ See the shell scripts section in the Doxygen documentation (`File List`, `detail
 Use American, rather than British English, spelling. This will facilitate consistent
 text searches. User text may be translated via the en_GB.po file.
 
 Use American, rather than British English, spelling. This will facilitate consistent
 text searches. User text may be translated via the en_GB.po file.
 

+To avoid confusion between American and British date formats, use ISO format (YYYY-MM-DD) where possible.
+

 To document the code use the following rules to allow extraction with Doxygen.  
 Not all comments have to be Doxygen comments.
 
 To document the code use the following rules to allow extraction with Doxygen.  
 Not all comments have to be Doxygen comments.