Reflect doc enhancements

Author: stringintech

kernel/chainstate_manager.go

@@ -123,7 +123,7 @@ func (cm *ChainstateManager) GetBlockTreeEntryByHash(blockHash BlockHashLike) *B
 
 // ImportBlocks triggers a reindex and/or imports block files from the filesystem.
 //
-// This starts a reindex if the wipe_dbs option was previously set via ChainstateManagerOptions.
+// This starts a reindex if the wipe options were previously set via ChainstateManagerOptions.
 // It can also import existing block files from the specified filesystem paths.
 //
 // Parameters:

kernel/coin.go

@@ -62,7 +62,7 @@ func (c *coinApi) GetOutput() *TransactionOutputView {
 	return newTransactionOutputView(check(ptr))
 }
 
-// ConfirmationHeight returns the block height at which this coin's prevout was created.
+// ConfirmationHeight returns the block height where the transaction that created this coin was included in.
 func (c *coinApi) ConfirmationHeight() uint32 {
 	return uint32(C.btck_coin_confirmation_height(c.ptr))
 }

kernel/context_options.go

@@ -36,9 +36,9 @@ func (contextOptionsCFuncs) destroy(ptr unsafe.Pointer) {
 // ContextOptions holds options for creating a new kernel context.
 //
 // Once a kernel Context has been created from these options, they may be destroyed.
-// The options hold the notification callbacks as well as the selected chain type
-// until they are passed to the context. If no options are configured, the context
-// will be instantiated with no callbacks and for mainnet.
+// The options hold the notification callbacks, validation interface callbacks, as well
+// as the selected chain type until they are passed to the context. If no options are
+// configured, the context will be instantiated with no callbacks and for mainnet.
 type ContextOptions struct {
 	*uniqueHandle
 }

kernel/logging_connection.go

@@ -84,19 +84,25 @@ func SetLoggingOptions(options LoggingOptions) {
 
 // DisableLogging permanently disables the global internal logger.
 //
-// No log messages will be buffered internally after this is called, and the buffer
-// is cleared. This function should only be called once and is not thread-safe or
-// re-entry safe.
+// Log messages will be buffered until this function is called, or a logging connection
+// is created. This must not be called while a logging connection already exists.
+// This function should only be called once and is not thread-safe or re-entry safe.
 func DisableLogging() {
 	C.btck_logging_disable()
 }
 
 // AddLogLevelCategory sets the log level for a specific category.
 //
-// This changes a global setting and affects all existing LoggingConnection instances.
+// This does not enable the selected categories. Use EnableLogCategory to
+// start logging from a specific, or all categories. This changes a global
+// setting and will override settings for all existing LoggingConnection instances.
 //
 // Parameters:
-//   - category: Log category to configure (or LogAll for all categories)
+//   - category: If LogAll is chosen, sets both the global fallback log level
+//     used by all categories that don't have a specific level set, and also
+//     sets the log level for messages logged with the LogAll category itself.
+//     For any other category, sets a category-specific log level that overrides
+//     the global fallback for that category only.
 //   - level: Minimum log level (Trace, Debug, or Info)
 //
 // Messages at the specified level and above will be logged for the category.

kernel/transaction_out_point.go

@@ -51,7 +51,7 @@ func (t *transactionOutPointApi) Copy() *TransactionOutPoint {
 	return newTransactionOutPoint(t.ptr, false)
 }
 
-// GetIndex returns the output position from the out point.
+// GetIndex returns the output position from the transaction out point.
 func (t *transactionOutPointApi) GetIndex() uint32 {
 	return uint32(C.btck_transaction_out_point_get_index(t.ptr))
 }