generate_comments_copy_function(p_source_schema text, p_source_name text, p_target_schema text, p_target_name text, p_supplemental text DEFAULT NULL::text)

Copies the comments of a source function to be the comments of a different target function.

Parameters

• p_source_schema :: Required? True; Default: ( No Default )

  The name of the schema which hosts the function whose comments are to be copied.

• p_source_name :: Required? True; Default: ( No Default )

  The function name from which comments will be copied.

• p_target_schema :: Required? True; Default: ( No Default )

  The name of the schema which hosts the function which will receive the copied comments.

• p_target_name :: Required? True; Default: ( No Default )

  The name of the function to which the copied comments will be applied.

• p_supplemental :: Required? False; Default: ( No Default )

  An optional text which can be added to the copied comments in a special “Supplemental” section. This allows the target function to have additional notes if appropriate.

General Usage

The use case for this function is many Public API functions are just wrappers exposing functions defined in the private logic. In these cases the private function logic will generally apply to the Public API wrapper and the private function can serve as a single source of the documentation.

Note that this function current doesn’t work with overloaded functions.