Skip to content

Commit 21c8932

Browse files
committed
Fix doxygen examples
1 parent 03df08d commit 21c8932

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

include/objectbox.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1351,7 +1351,9 @@ OBX_C_API obx_qb_cond obx_qb_any(OBX_query_builder* builder, const obx_qb_cond c
13511351
/// Create an alias for the previous condition (the one added just before calling this function).
13521352
/// This is useful when you have a query with multiple conditions of the same property (e.g. height < 20 or height > 50)
13531353
/// and you want to use obx_query_param_* to change the values. Consider the following simplified example.
1354-
/// @example Create a query with two aliased params and set their values later during query execution:
1354+
///
1355+
/// **Example:** Create a query with two aliased params and set their values later during query execution:
1356+
///
13551357
/// OBX_query_builder* qb = obx_query_builder(store, entity_id);
13561358
/// obx_qb_less_than_int(qb, height_prop_id, 0)
13571359
/// obx_qb_param_alias(qb, "height-lt")

include/objectbox.hpp

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1269,7 +1269,9 @@ class QueryBuilder {
12691269
: QueryBuilder(store, obx_query_builder(store.cPtr(), EntityBinding::entityId()), true) {}
12701270

12711271
/// Take ownership of an OBX_query_builder.
1272-
/// @example
1272+
///
1273+
/// *Example:**
1274+
///
12731275
/// QueryBuilder innerQb(obx_qb_link_property(outerQb.cPtr(), linkPropertyId), false)
12741276
explicit QueryBuilder(Store& store, OBX_query_builder* ptr, bool isRoot)
12751277
: store_(store), cQueryBuilder_(ptr), isRoot_(isRoot) {
@@ -1831,7 +1833,9 @@ class Box {
18311833
/// @param toOneRel the relation property, which must belong to the entity type represented by this box.
18321834
/// @param objectId this relation points to - typically ID of an object of another entity type (another box).
18331835
/// @returns resulting IDs representing objects in this Box, or NULL in case of an error
1834-
/// @example Let's say you have the following two entities with a relation between them (.fbs file format):
1836+
///
1837+
/// **Example** Let's say you have the following two entities with a relation between them (.fbs file format):
1838+
///
18351839
/// table Customer {
18361840
/// id:ulong;
18371841
/// name:string;

0 commit comments

Comments
 (0)