1
0
mirror of https://github.com/postgres/postgres.git synced 2025-12-13 14:22:43 +03:00

Fix some comments.

Like commit 123661427b, these were discovered while reviewing
Aleksander Alekseev's proposed changes to pgindent.
This commit is contained in:
Nathan Bossart
2025-12-11 15:13:04 -06:00
parent 81f72115cf
commit b4cbc106a6
13 changed files with 19 additions and 17 deletions

View File

@@ -307,9 +307,8 @@ pq_endmessage(StringInfo buf)
* *
* The data buffer is *not* freed, allowing to reuse the buffer with * The data buffer is *not* freed, allowing to reuse the buffer with
* pq_beginmessage_reuse. * pq_beginmessage_reuse.
-------------------------------- * --------------------------------
*/ */
void void
pq_endmessage_reuse(StringInfo buf) pq_endmessage_reuse(StringInfo buf)
{ {

View File

@@ -2620,7 +2620,7 @@ view_col_is_auto_updatable(RangeTblRef *rtr, TargetEntry *tle)
* view_query_is_auto_updatable - test whether the specified view definition * view_query_is_auto_updatable - test whether the specified view definition
* represents an auto-updatable view. Returns NULL (if the view can be updated) * represents an auto-updatable view. Returns NULL (if the view can be updated)
* or a message string giving the reason that it cannot be. * or a message string giving the reason that it cannot be.
*
* The returned string has not been translated; if it is shown as an error * The returned string has not been translated; if it is shown as an error
* message, the caller should apply _() to translate it. * message, the caller should apply _() to translate it.
* *

View File

@@ -114,7 +114,8 @@ FileSetCreate(FileSet *fileset, const char *name)
} }
/* /*
* Open a file that was created with FileSetCreate() */ * Open a file that was created with FileSetCreate()
*/
File File
FileSetOpen(FileSet *fileset, const char *name, int mode) FileSetOpen(FileSet *fileset, const char *name, int mode)
{ {

View File

@@ -113,7 +113,7 @@ static const int8 hexlookup[128] = {
* pg_strtoint16() will throw ereport() upon bad input format or overflow; * pg_strtoint16() will throw ereport() upon bad input format or overflow;
* while pg_strtoint16_safe() instead returns such complaints in *escontext, * while pg_strtoint16_safe() instead returns such complaints in *escontext,
* if it's an ErrorSaveContext. * if it's an ErrorSaveContext.
* *
* NB: Accumulate input as an unsigned number, to deal with two's complement * NB: Accumulate input as an unsigned number, to deal with two's complement
* representation of the most negative number, which can't be represented as a * representation of the most negative number, which can't be represented as a
* signed positive number. * signed positive number.

View File

@@ -5643,7 +5643,7 @@ RelationGetIdentityKeyBitmap(Relation relation)
* This should be called only for an index that is known to have an associated * This should be called only for an index that is known to have an associated
* exclusion constraint or primary key/unique constraint using WITHOUT * exclusion constraint or primary key/unique constraint using WITHOUT
* OVERLAPS. * OVERLAPS.
*
* It returns arrays (palloc'd in caller's context) of the exclusion operator * It returns arrays (palloc'd in caller's context) of the exclusion operator
* OIDs, their underlying functions' OIDs, and their strategy numbers in the * OIDs, their underlying functions' OIDs, and their strategy numbers in the
* index's opclasses. We cache all this information since it requires a fair * index's opclasses. We cache all this information since it requires a fair

View File

@@ -484,7 +484,7 @@ pg_mb_radix_conv(const pg_mb_radix_tree *rt,
* utf: input string in UTF8 encoding (need not be null-terminated) * utf: input string in UTF8 encoding (need not be null-terminated)
* len: length of input string (in bytes) * len: length of input string (in bytes)
* iso: pointer to the output area (must be large enough!) * iso: pointer to the output area (must be large enough!)
(output string will be null-terminated) * (output string will be null-terminated)
* map: conversion map for single characters * map: conversion map for single characters
* cmap: conversion map for combined characters * cmap: conversion map for combined characters
* (optional, pass NULL if none) * (optional, pass NULL if none)
@@ -694,7 +694,7 @@ UtfToLocal(const unsigned char *utf, int len,
* iso: input string in local encoding (need not be null-terminated) * iso: input string in local encoding (need not be null-terminated)
* len: length of input string (in bytes) * len: length of input string (in bytes)
* utf: pointer to the output area (must be large enough!) * utf: pointer to the output area (must be large enough!)
(output string will be null-terminated) * (output string will be null-terminated)
* map: conversion map for single characters * map: conversion map for single characters
* cmap: conversion map for combined characters * cmap: conversion map for combined characters
* (optional, pass NULL if none) * (optional, pass NULL if none)

View File

@@ -497,7 +497,8 @@ pg_do_encoding_conversion_buf(Oid proc,
* Convert string to encoding encoding_name. The source * Convert string to encoding encoding_name. The source
* encoding is the DB encoding. * encoding is the DB encoding.
* *
* BYTEA convert_to(TEXT string, NAME encoding_name) */ * BYTEA convert_to(TEXT string, NAME encoding_name)
*/
Datum Datum
pg_convert_to(PG_FUNCTION_ARGS) pg_convert_to(PG_FUNCTION_ARGS)
{ {
@@ -522,7 +523,8 @@ pg_convert_to(PG_FUNCTION_ARGS)
* Convert string from encoding encoding_name. The destination * Convert string from encoding encoding_name. The destination
* encoding is the DB encoding. * encoding is the DB encoding.
* *
* TEXT convert_from(BYTEA string, NAME encoding_name) */ * TEXT convert_from(BYTEA string, NAME encoding_name)
*/
Datum Datum
pg_convert_from(PG_FUNCTION_ARGS) pg_convert_from(PG_FUNCTION_ARGS)
{ {

View File

@@ -5449,7 +5449,7 @@ ShowGUCOption(const struct config_generic *record, bool use_units)
* variable sourceline, integer * variable sourceline, integer
* variable source, integer * variable source, integer
* variable scontext, integer * variable scontext, integer
* variable srole, OID * variable srole, OID
*/ */
static void static void
write_one_nondefault_variable(FILE *fp, struct config_generic *gconf) write_one_nondefault_variable(FILE *fp, struct config_generic *gconf)

View File

@@ -23,8 +23,8 @@
/* /*
* AlignedAllocFree * AlignedAllocFree
* Frees allocated memory; memory is removed from its owning context. * Frees allocated memory; memory is removed from its owning context.
*/ */
void void
AlignedAllocFree(void *pointer) AlignedAllocFree(void *pointer)
{ {

View File

@@ -853,7 +853,8 @@ AtAbort_Portals(void)
/* /*
* Post-abort cleanup for portals. * Post-abort cleanup for portals.
* *
* Delete all portals not held over from prior transactions. */ * Delete all portals not held over from prior transactions.
*/
void void
AtCleanup_Portals(void) AtCleanup_Portals(void)
{ {

View File

@@ -1132,7 +1132,6 @@ tuplesort_getgintuple(Tuplesortstate *state, Size *len, bool forward)
* efficient, but only safe for callers that are prepared to have any * efficient, but only safe for callers that are prepared to have any
* subsequent manipulation of the tuplesort's state invalidate slot contents. * subsequent manipulation of the tuplesort's state invalidate slot contents.
* For byval Datums, the value of the 'copy' parameter has no effect. * For byval Datums, the value of the 'copy' parameter has no effect.
*/ */
bool bool
tuplesort_getdatum(Tuplesortstate *state, bool forward, bool copy, tuplesort_getdatum(Tuplesortstate *state, bool forward, bool copy,

View File

@@ -404,7 +404,7 @@ ExecEvalExpr(ExprState *state,
* Like ExecEvalExpr(), but for cases where no return value is expected, * Like ExecEvalExpr(), but for cases where no return value is expected,
* because the side-effects of expression evaluation are what's desired. This * because the side-effects of expression evaluation are what's desired. This
* is e.g. used for projection and aggregate transition computation. * is e.g. used for projection and aggregate transition computation.
*
* Evaluate expression identified by "state" in the execution context * Evaluate expression identified by "state" in the execution context
* given by "econtext". * given by "econtext".
* *