Commit 3612019a authored by Peter Eisentraut's avatar Peter Eisentraut

doc: Document function pointer source code style

as implemented in 1356f78e
parent 821fb8cd
...@@ -964,5 +964,23 @@ handle_sighup(SIGNAL_ARGS) ...@@ -964,5 +964,23 @@ handle_sighup(SIGNAL_ARGS)
</para> </para>
</simplesect> </simplesect>
<simplesect>
<title>Calling Function Pointers</title>
<para>
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:
<programlisting>
(*emit_log_hook) (edata);
</programlisting>
(even though <literal>emit_log_hook(edata)</literal> would also work).
When the function pointer is part of a structure, then the extra
punctuation can and usually should be omitted, for example:
<programlisting>
paramInfo->paramFetch(paramInfo, paramId);
</programlisting>
</para>
</simplesect>
</sect1> </sect1>
</chapter> </chapter>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment