database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-09-02 04:21:28 +03:00
Code Activity

doc: Document function pointer source code style

Browse Source 
as implemented in 1356f78ea9
This commit is contained in:
Peter Eisentraut
2017-09-11 14:47:15 -04:00
parent 821fb8cdbf
commit 3612019a79
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
doc/src/sgml/sources.sgml
View File

@@ -964,5 +964,23 @@ handle_sighup(SIGNAL_ARGS)
</para>
</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>
</chapter>