Index: src/sqlite.h.in
==================================================================
--- src/sqlite.h.in
+++ src/sqlite.h.in
@@ -7409,39 +7409,40 @@
/* #define SQLITE_IGNORE 2 // Also used by sqlite3_authorizer() callback */
#define SQLITE_FAIL 3
/* #define SQLITE_ABORT 4 // Also an error code */
#define SQLITE_REPLACE 5
-/* CAPI3REF: Prepared Statement Scan Status Opcodes
-** KEYWORDS: {scanstatus option}
+/*
+** CAPI3REF: Prepared Statement Scan Status Opcodes
+** KEYWORDS: {scanstatus options}
**
** The following constants can be used for the T parameter to the
** [sqlite3_stmt_scanstatus(S,X,T,V)] interface. Each constant designates a
** different metric for sqlite3_stmt_scanstatus() to return.
**
**
-** [[SQLITE_SCANSTAT_NLOOP]] SQLITE_SCANSTAT_NLOOP
-** - The [sqlite3_int64] variable pointed to by the T parameter will be set to the
+** [[SQLITE_SCANSTAT_NLOOP]]
- SQLITE_SCANSTAT_NLOOP
+** - ^The [sqlite3_int64] variable pointed to by the T parameter will be set to the
** total number of times that the X-th loop has run.
**
-** [[SQLITE_SCANSTAT_NVISIT]] | SQLITE_SCANSTAT_NVISIT
-** - The [sqlite3_int64] variable pointed to by the T parameter will be set to the
+** [[SQLITE_SCANSTAT_NVISIT]]
- SQLITE_SCANSTAT_NVISIT
+** - ^The [sqlite3_int64] variable pointed to by the T parameter will be set to the
** total number of rows visited by the X-th loop.
**
-** [[SQLITE_SCANSTAT_EST]] | SQLITE_SCANSTAT_EST
-** - The [sqlite3_int64] variable pointed to by the T parameter will be set to the
+** [[SQLITE_SCANSTAT_EST]]
- SQLITE_SCANSTAT_EST
+** - ^The [sqlite3_int64] variable pointed to by the T parameter will be set to the
** query planner's estimate for the number of rows visited for each
** iteration of the X-th loop. If the query planner's estimate was accurate,
** then this value should be approximately NVISIT/NLOOP.
**
-** [[SQLITE_SCANSTAT_NAME]]
SQLITE_SCANSTAT_NAME
-** - The "const char *" variable pointed to by the T parameter will be set to
+** [[SQLITE_SCANSTAT_NAME]]
- SQLITE_SCANSTAT_NAME
+** - ^The "const char *" variable pointed to by the T parameter will be set to
** a zero-terminated UTF-8 string containing the name of the index or table used
** for the X-th loop.
**
-** [[SQLITE_SCANSTAT_EXPLAIN]]
SQLITE_SCANSTAT_EXPLAIN
-** - The "const char *" variable pointed to by the T parameter will be set to
+** [[SQLITE_SCANSTAT_EXPLAIN]]
- SQLITE_SCANSTAT_EXPLAIN
+** - ^The "const char *" variable pointed to by the T parameter will be set to
** a zero-terminated UTF-8 string containing the [EXPLAIN QUERY PLAN] description
** for the X-th loop.
**
*/
#define SQLITE_SCANSTAT_NLOOP 0
@@ -7456,25 +7457,27 @@
** Return status data for a single loop within query pStmt.
**
** The "iScanStatusOp" parameter determines which status information to return.
** The "iScanStatusOp" must be one of the [scanstatus options] or the behavior of
** this interface is undefined.
-** The requested measurement is written into a variable pointed to by
+** ^The requested measurement is written into a variable pointed to by
** the "pOut" parameter.
** Parameter "idx" identifies the specific loop to retrieve statistics for.
-** Loops are numbered starting from zero. If idx is out of range - less than
+** Loops are numbered starting from zero. ^If idx is out of range - less than
** zero or greater than or equal to the total number of loops used to implement
** the statement - a non-zero value is returned and the variable that pOut
** points to is unchanged.
**
-** Statistics might not be available for all loops in all statements. In cases
+** ^Statistics might not be available for all loops in all statements. ^In cases
** where there exist loops with no available statistics, this function behaves
** as if the loop did not exist - it returns non-zero and leave the variable
** that pOut points to unchanged.
**
** This API is only available if the library is built with pre-processor
** symbol [SQLITE_ENABLE_STMT_SCANSTATUS] defined.
+**
+** See also: [sqlite3_stmt_scanstatus_reset()]
*/
SQLITE_EXPERIMENTAL int sqlite3_stmt_scanstatus(
sqlite3_stmt *pStmt, /* Prepared statement for which info desired */
int idx, /* Index of loop to report on */
int iScanStatusOp, /* Information desired. SQLITE_SCANSTAT_* */
@@ -7482,11 +7485,11 @@
);
/*
** CAPI3REF: Zero Scan-Status Counters
**
-** Zero all sqlite3_stmt_scanstatus() related event counters.
+** ^Zero all [sqlite3_stmt_scanstatus()] related event counters.
**
** This API is only available if the library is built with pre-processor
** symbol [SQLITE_ENABLE_STMT_SCANSTATUS] defined.
*/
SQLITE_EXPERIMENTAL void sqlite3_stmt_scanstatus_reset(sqlite3_stmt*);
| | |