doc: Document function pointer source code style
authorPeter Eisentraut
Mon, 11 Sep 2017 18:47:15 +0000 (14:47 -0400)
committerPeter Eisentraut
Mon, 11 Sep 2017 18:47:15 +0000 (14:47 -0400)
as implemented in 1356f78ea93395c107cbc75dc923e29a0efccd8a

doc/src/sgml/sources.sgml

index 877fcedbb3a31e68387a33a6e0a6b9fc77f3c0b1..7777bf519958bdf705ffe90ebf3bc4f1c92320e3 100644 (file)
@@ -964,5 +964,23 @@ handle_sighup(SIGNAL_ARGS)
     
    
 
+   
+    Calling Function Pointers
+
+    
+     For clarity, it is preferred to explicitly dereference a function pointer
+     when calling the pointed-to function if the pointer is a simple variable,
+     for example:
+
+(*emit_log_hook) (edata);
+
+     (even though emit_log_hook(edata) would also work).
+     When the function pointer is part of a structure, then the extra
+     punctuation can and usually should be omitted, for example:
+
+paramInfo->paramFetch(paramInfo, paramId);
+
+    
+