Skip to content

docs(format): fix doxygen syntax #137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lidavidm merged 2 commits into from
Sep 20, 2022
Merged

docs(format): fix doxygen syntax #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c83fe2f
docs(format): fix doxygen syntax
lidavidm Sep 20, 2022
123ec35
ci: fix the title check regex one more time
lidavidm Sep 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/dev_pr/title_check.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ const COMMENT_BODY = ":warning: Please follow the [Conventional Commits format i

function matchesCommitFormat(title) {
const commitType = `(${COMMIT_TYPES.join('|')})`;
const scope = "\([a-zA-Z0-9_/\\-,]+\)?";
const scope = "\\([a-zA-Z0-9_/\\-,]+\\)?";
const delimiter = "!?:";
const subject = " .+";
const regexp = new RegExp(`^${commitType}${scope}${delimiter}${subject}$`);
Expand Down
99 changes: 52 additions & 47 deletions adbc.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,50 +465,50 @@ AdbcStatusCode AdbcConnectionGetInfo(struct AdbcConnection* connection,
///
/// The result is an Arrow dataset with the following schema:
///
/// Field Name | Field Type
/// -------------------------|-----------------------
/// catalog_name | utf8
/// catalog_db_schemas | list<DB_SCHEMA_SCHEMA>
/// | Field Name | Field Type |
/// |--------------------------|-------------------------|
/// | catalog_name | utf8 |
/// | catalog_db_schemas | list<DB_SCHEMA_SCHEMA> |
///
/// DB_SCHEMA_SCHEMA is a Struct with fields:
///
/// Field Name | Field Type
/// -------------------------|-----------------------
/// db_schema_name | utf8
/// db_schema_tables | list<TABLE_SCHEMA>
/// | Field Name | Field Type |
/// |--------------------------|-------------------------|
/// | db_schema_name | utf8 |
/// | db_schema_tables | list<TABLE_SCHEMA> |
///
/// TABLE_SCHEMA is a Struct with fields:
///
/// Field Name | Field Type
/// -------------------------|-----------------------
/// table_name | utf8 not null
/// table_type | utf8 not null
/// table_columns | list<COLUMN_SCHEMA>
/// table_constraints | list<CONSTRAINT_SCHEMA>
/// | Field Name | Field Type |
/// |--------------------------|-------------------------|
/// | table_name | utf8 not null |
/// | table_type | utf8 not null |
/// | table_columns | list<COLUMN_SCHEMA> |
/// | table_constraints | list<CONSTRAINT_SCHEMA> |
///
/// COLUMN_SCHEMA is a Struct with fields:
///
/// Field Name | Field Type | Comments
/// -------------------------|-----------------------|---------
/// column_name | utf8 not null |
/// ordinal_position | int32 | (1)
/// remarks | utf8 | (2)
/// xdbc_data_type | int16 | (3)
/// xdbc_type_name | utf8 | (3)
/// xdbc_column_size | int32 | (3)
/// xdbc_decimal_digits | int16 | (3)
/// xdbc_num_prec_radix | int16 | (3)
/// xdbc_nullable | int16 | (3)
/// xdbc_column_def | utf8 | (3)
/// xdbc_sql_data_type | int16 | (3)
/// xdbc_datetime_sub | int16 | (3)
/// xdbc_char_octet_length | int32 | (3)
/// xdbc_is_nullable | utf8 | (3)
/// xdbc_scope_catalog | utf8 | (3)
/// xdbc_scope_schema | utf8 | (3)
/// xdbc_scope_table | utf8 | (3)
/// xdbc_is_autoincrement | bool | (3)
/// xdbc_is_generatedcolumn | bool | (3)
/// | Field Name | Field Type | Comments |
/// |--------------------------|-------------------------|----------|
/// | column_name | utf8 not null | |
/// | ordinal_position | int32 | (1) |
/// | remarks | utf8 | (2) |
/// | xdbc_data_type | int16 | (3) |
/// | xdbc_type_name | utf8 | (3) |
/// | xdbc_column_size | int32 | (3) |
/// | xdbc_decimal_digits | int16 | (3) |
/// | xdbc_num_prec_radix | int16 | (3) |
/// | xdbc_nullable | int16 | (3) |
/// | xdbc_column_def | utf8 | (3) |
/// | xdbc_sql_data_type | int16 | (3) |
/// | xdbc_datetime_sub | int16 | (3) |
/// | xdbc_char_octet_length | int32 | (3) |
/// | xdbc_is_nullable | utf8 | (3) |
/// | xdbc_scope_catalog | utf8 | (3) |
/// | xdbc_scope_schema | utf8 | (3) |
/// | xdbc_scope_table | utf8 | (3) |
/// | xdbc_is_autoincrement | bool | (3) |
/// | xdbc_is_generatedcolumn | bool | (3) |
///
/// 1. The column's ordinal position in the table (starting from 1).
/// 2. Database-specific description of the column.
Expand All @@ -518,12 +518,12 @@ AdbcStatusCode AdbcConnectionGetInfo(struct AdbcConnection* connection,
///
/// CONSTRAINT_SCHEMA is a Struct with fields:
///
/// Field Name | Field Type | Comments
/// -------------------------|-----------------------|---------
/// constraint_name | utf8 |
/// constraint_type | utf8 not null | (1)
/// constraint_column_names | list<utf8> not null | (2)
/// constraint_column_usage | list<USAGE_SCHEMA> | (3)
/// | Field Name | Field Type | Comments |
/// |--------------------------|-------------------------|----------|
/// | constraint_name | utf8 | |
/// | constraint_type | utf8 not null | (1) |
/// | constraint_column_names | list<utf8> not null | (2) |
/// | constraint_column_usage | list<USAGE_SCHEMA> | (3) |
///
/// 1. One of 'CHECK', 'FOREIGN KEY', 'PRIMARY KEY', or 'UNIQUE'.
/// 2. The columns on the current table that are constrained, in
Expand All @@ -532,12 +532,12 @@ AdbcStatusCode AdbcConnectionGetInfo(struct AdbcConnection* connection,
///
/// USAGE_SCHEMA is a Struct with fields:
///
/// Field Name | Field Type | Comments
/// -------------------------|-----------------------|---------
/// fk_catalog | utf8 |
/// fk_db_schema | utf8 |
/// fk_table | utf8 not null |
/// fk_column_name | utf8 not null |
/// | Field Name | Field Type |
/// |--------------------------|-------------------------|
/// | fk_catalog | utf8 |
/// | fk_db_schema | utf8 |
/// | fk_table | utf8 not null |
/// | fk_column_name | utf8 not null |
///
/// \param[in] connection The database connection.
/// \param[in] depth The level of nesting to display. If 0, display
Expand Down Expand Up @@ -570,10 +570,15 @@ AdbcStatusCode AdbcConnectionGetObjects(struct AdbcConnection* connection, int d
struct ArrowArrayStream* out,
struct AdbcError* error);

/// \brief Return metadata on catalogs, schemas, tables, and columns.
#define ADBC_OBJECT_DEPTH_ALL 0
/// \brief Return metadata on catalogs only.
#define ADBC_OBJECT_DEPTH_CATALOGS 1
/// \brief Return metadata on catalogs and schemas.
#define ADBC_OBJECT_DEPTH_DB_SCHEMAS 2
/// \brief Return metadata on catalogs, schemas, and tables.
#define ADBC_OBJECT_DEPTH_TABLES 3
/// \brief Return metadata on catalogs, schemas, tables, and columns.
#define ADBC_OBJECT_DEPTH_COLUMNS ADBC_OBJECT_DEPTH_ALL

/// \brief Get the Arrow schema of a table.
Expand Down