ext/snowcrash/src/CBlueprint.h in redsnow-0.2.0 vs ext/snowcrash/src/CBlueprint.h in redsnow-0.2.1
- old
+ new
@@ -21,11 +21,12 @@
typedef unsigned int sc_blueprint_parser_options;
/** brief Blueprint Parser Options Enums */
enum sc_blueprint_parser_option {
SC_RENDER_DESCRIPTIONS_OPTION = (1 << 0), /// < Render Markdown in description.
- SC_REQUIRE_BLUEPRINT_NAME_OPTION = (1 << 1) /// < Treat missing blueprint name as error
+ SC_REQUIRE_BLUEPRINT_NAME_OPTION = (1 << 1), /// < Treat missing blueprint name as error
+ SC_EXPORT_SORUCEMAP_OPTION = (1 << 2) /// < Export source maps AST
};
/** Parameter Use flag */
typedef enum sc_parameter_use {
SC_UNDEFINED_PARAMETER_USE,
@@ -43,23 +44,23 @@
/** Class Metadata wrapper */
struct sc_metadata_s;
typedef struct sc_metadata_s sc_metadata_t;
- /** Array Resource Groups wrapper */
- struct sc_resource_groups_collection_s;
- typedef struct sc_resource_groups_collection_s sc_resource_groups_collection_t;
+ /** Array Resource Group Collection wrapper */
+ struct sc_resource_group_collection_s;
+ typedef struct sc_resource_group_collection_s sc_resource_group_collection_t;
/** Class Resource Group wrapper */
- struct sc_resource_groups_s;
- typedef struct sc_resource_groups_s sc_resource_groups_t;
+ struct sc_resource_group_s;
+ typedef struct sc_resource_group_s sc_resource_group_t;
- /** Array Resources Collection wrapper */
+ /** Array Resource Collection wrapper */
struct sc_resource_collection_s;
typedef struct sc_resource_collection_s sc_resource_collection_t;
- /** Class Resources wrapper */
+ /** Class Resource wrapper */
struct sc_resource_s;
typedef struct sc_resource_s sc_resource_t;
/** Class Resource Model wrapper */
struct sc_resource_model_s;
@@ -95,18 +96,10 @@
/** class Value wrapper */
struct sc_value_s;
typedef struct sc_value_s sc_value_t;
- /** Array Header wrapper */
- struct sc_header_collection_s;
- typedef struct sc_header_collection_s sc_header_collection_t;
-
- /** class Header wrapper */
- struct sc_header_s;
- typedef struct sc_header_s sc_header_t;
-
/** Array Action wrapper */
struct sc_action_collection_s;
typedef struct sc_action_collection_s sc_action_collection_t;
/** class Action wrapper */
@@ -121,25 +114,25 @@
struct sc_transaction_example_s;
typedef struct sc_transaction_example_s sc_transaction_example_t;
/*----------------------------------------------------------------------*/
- /** \returns pointer to allocated Blueprint*/
+ /** \returns pointer to allocated Blueprint */
SC_API sc_blueprint_t* sc_blueprint_new();
- /** \deallocate Blueprint from pointer*/
+ /** \deallocate Blueprint from pointer */
SC_API void sc_blueprint_free(sc_blueprint_t* blueprint);
/** \returns Blueprint name */
SC_API const char* sc_blueprint_name(const sc_blueprint_t* blueprint);
/** \returns Blueprint description */
SC_API const char* sc_blueprint_description(const sc_blueprint_t* blueprint);
/*----------------------------------------------------------------------*/
- /** \returns Metadata Handle */
+ /** \returns Metadata array handle */
SC_API const sc_metadata_collection_t* sc_metadata_collection_handle(const sc_blueprint_t* blueprint);
/** \returns size of Metadata array */
SC_API size_t sc_metadata_collection_size(const sc_metadata_collection_t* metadata);
@@ -154,38 +147,38 @@
/** \returns Metadata value */
SC_API const char* sc_metadata_value(const sc_metadata_t* metadata);
/*----------------------------------------------------------------------*/
- /** \returns Resource Groups Array Handle */
- SC_API const sc_resource_groups_collection_t* sc_resource_groups_collection_handle(const sc_blueprint_t* blueprint);
+ /** \returns Resource Group Collection array handle */
+ SC_API const sc_resource_group_collection_t* sc_resource_group_collection_handle(const sc_blueprint_t* blueprint);
- /** \returns size of Resource Groups array */
- SC_API size_t sc_resource_groups_collection_size(const sc_resource_groups_collection_t* resource);
+ /** \returns size of Resource Group Collection array */
+ SC_API size_t sc_resource_group_collection_size(const sc_resource_group_collection_t* resource);
/*----------------------------------------------------------------------*/
- /** \returns Resource Groups Handle */
- SC_API const sc_resource_groups_t* sc_resource_groups_handle(const sc_resource_groups_collection_t* resource, size_t index);
+ /** \returns Resource Group handle */
+ SC_API const sc_resource_group_t* sc_resource_group_handle(const sc_resource_group_collection_t* resource, size_t index);
- /** \returns Resource Groups name */
- SC_API const char* sc_resource_groups_name(const sc_resource_groups_t* handle);
+ /** \returns Resource Group name */
+ SC_API const char* sc_resource_group_name(const sc_resource_group_t* handle);
- /** \returns Resource Groups Description */
- SC_API const char* sc_resource_groups_description(const sc_resource_groups_t* handle);
+ /** \returns Resource Group description */
+ SC_API const char* sc_resource_group_description(const sc_resource_group_t* handle);
/*----------------------------------------------------------------------*/
- /** \returns Resource Array Handle */
- SC_API const sc_resource_collection_t* sc_resource_collection_handle(const sc_resource_groups_t* handle);
+ /** \returns Resource array handle */
+ SC_API const sc_resource_collection_t* sc_resource_collection_handle(const sc_resource_group_t* handle);
- /** \returns Resource array size*/
+ /** \returns Resource array size */
SC_API size_t sc_resource_collection_size(const sc_resource_collection_t* resource);
/*----------------------------------------------------------------------*/
- /** \returns Resource Handle */
+ /** \returns Resource handle */
SC_API const sc_resource_t* sc_resource_handle(const sc_resource_collection_t* resource, size_t index);
/** \returns Resource URITemplate */
SC_API const char* sc_resource_uritemplate(const sc_resource_t* handle);
@@ -195,30 +188,33 @@
/** \returns Resource description */
SC_API const char* sc_resource_description(const sc_resource_t* handle);
/*----------------------------------------------------------------------*/
- /** \returns Payload Collection handle from TransactionExample for requests*/
+ /** \returns Payload Collection array handle from TransactionExample for requests*/
SC_API const sc_payload_collection_t* sc_payload_collection_handle_requests(const sc_transaction_example_t* handle);
- /** \returns Payload Collection handle from TransactionExample for responses*/
+ /** \returns Payload Collection array handle from TransactionExample for responses*/
SC_API const sc_payload_collection_t* sc_payload_collection_handle_responses(const sc_transaction_example_t* handle);
- /** \returns Payload Collection size */
+ /** \returns Payload Collection array size */
SC_API size_t sc_payload_collection_size(const sc_payload_collection_t* handle);
/*----------------------------------------------------------------------*/
- /** \returns Payload at `index` Handle*/
+ /** \returns Payload at `index` handle */
SC_API const sc_payload_t* sc_payload_handle(const sc_payload_collection_t* handle, size_t index);
- /** \returns Payload Handle from resource*/
+ /** \returns Payload handle from resource */
SC_API const sc_payload_t* sc_payload_handle_resource(const sc_resource_t* handle);
/** \returns Payload name */
SC_API const char* sc_payload_name(const sc_payload_t* handle);
+ /** \returns Payload symbol name */
+ SC_API const char* sc_payload_symbol(const sc_payload_t* handle);
+
/** \returns Payload description */
SC_API const char* sc_payload_description(const sc_payload_t* handle);
/** \returns Payload body */
SC_API const char* sc_payload_body(const sc_payload_t* handle);
@@ -226,17 +222,17 @@
/** \returns Payload schema */
SC_API const char* sc_payload_schema(const sc_payload_t* handle);
/*----------------------------------------------------------------------*/
- /** \returns Parameter Collection handle from Payload*/
+ /** \returns Parameter Collection handle from Payload */
SC_API const sc_parameter_collection_t* sc_parameter_collection_handle_payload(const sc_payload_t* handle);
- /** \returns Parameter Collection handle from Resource*/
+ /** \returns Parameter Collection handle from Resource */
SC_API const sc_parameter_collection_t* sc_parameter_collection_handle_resource(const sc_resource_t* handle);
- /** \returns Parameter Collection handle from Action*/
+ /** \returns Parameter Collection handle from Action */
SC_API const sc_parameter_collection_t* sc_parameter_collection_handle_action(const sc_action_t* handle);
/** \returns Parameter Collection size */
SC_API size_t sc_parameter_collection_size(const sc_parameter_collection_t* handle);
@@ -249,50 +245,50 @@
SC_API const char* sc_parameter_name(const sc_parameter_t* handle);
/** \returns Parameter description */
SC_API const char* sc_parameter_description(const sc_parameter_t* handle);
- /** \returns Parameter Type */
+ /** \returns Parameter type */
SC_API const char* sc_parameter_type(const sc_parameter_t* handle);
- /** \returns Parameter Parameter Use */
+ /** \returns Parameter use */
SC_API sc_parameter_use sc_parameter_parameter_use(const sc_parameter_t* handle);
- /** \returns Parameter Default Value */
+ /** \returns Parameter default value */
SC_API const char* sc_parameter_default_value(const sc_parameter_t* handle);
- /** \returns Parameter Example Value */
+ /** \returns Parameter example value */
SC_API const char* sc_parameter_example_value(const sc_parameter_t* handle);
/*----------------------------------------------------------------------*/
- /** \returns Value Collection handle */
+ /** \returns Value Collection array handle */
SC_API const sc_value_collection_t* sc_value_collection_handle(const sc_parameter_t* handle);
- /** \returns Value Collection size */
+ /** \returns Value Collection array size */
SC_API size_t sc_value_collection_size(const sc_value_collection_t* handle);
/*----------------------------------------------------------------------*/
/** \returns Value handle */
SC_API const sc_value_t* sc_value_handle(const sc_value_collection_t* handle, size_t index);
/** \returns Value string */
- SC_API const char* sc_value_string(const sc_value_t* handle);
+ SC_API const char* sc_value(const sc_value_t* handle);
/*----------------------------------------------------------------------*/
- /** \returns Header Collection handle from Payload*/
+ /** \returns Header Collection array handle from Payload */
SC_API const sc_header_collection_t* sc_header_collection_handle_payload(const sc_payload_t* handle);
- /** \returns Header Collection handle from Resource*/
+ /** \returns Header Collection array handle from Resource */
SC_API const sc_header_collection_t* sc_header_collection_handle_resource(const sc_resource_t* handle);
- /** \returns Header Collection handle from Action*/
+ /** \returns Header Collection array handle from Action */
SC_API const sc_header_collection_t* sc_header_collection_handle_action(const sc_action_t* handle);
- /** \returns Header Collection size */
+ /** \returns Header Collection array size */
SC_API size_t sc_header_collection_size(const sc_header_collection_t* handle);
/*----------------------------------------------------------------------*/
/** \returns Header handle */
@@ -304,14 +300,14 @@
/** \returns Header Value */
SC_API const char* sc_header_value(const sc_header_t* handle);
/*----------------------------------------------------------------------*/
- /** \returns Action Collection handle */
+ /** \returns Action Collection array handle */
SC_API const sc_action_collection_t* sc_action_collection_handle(const sc_resource_t* handle);
- /** \returns Action Collection size */
+ /** \returns Action Collection array size */
SC_API size_t sc_action_collection_size(const sc_action_collection_t* handle);
/*----------------------------------------------------------------------*/
/** \returns Action handle */
@@ -321,29 +317,29 @@
SC_API const char* sc_action_httpmethod(const sc_action_t* handle);
/** \returns Action name */
SC_API const char* sc_action_name(const sc_action_t* handle);
- /** \returns Action Description */
+ /** \returns Action description */
SC_API const char* sc_action_description(const sc_action_t* handle);
/*----------------------------------------------------------------------*/
- /** \returns Transaction Example Collection handle */
+ /** \returns Transaction Example Collection array handle */
SC_API const sc_transaction_example_collection_t* sc_transaction_example_collection_handle(const sc_action_t* handle);
- /** \returns Transaction Example Collection size */
+ /** \returns Transaction Example Collection array size */
SC_API size_t sc_transaction_example_collection_size(const sc_transaction_example_collection_t* handle);
/*----------------------------------------------------------------------*/
/** \returns Transaction Example handle */
SC_API const sc_transaction_example_t* sc_transaction_example_handle(const sc_transaction_example_collection_t* handle, size_t index);
/** \returns Transaction Example name */
SC_API const char* sc_transaction_example_name(const sc_transaction_example_t* handle);
- /** \returns Transaction Example Description */
+ /** \returns Transaction Example description */
SC_API const char* sc_transaction_example_description(const sc_transaction_example_t* handle);
/*----------------------------------------------------------------------*/
#ifdef __cplusplus