Skip to content
Snippets Groups Projects
Verified Commit 7748c0d9 authored by Daniel Hornung's avatar Daniel Hornung
Browse files

MAINT: Fixed a few documentation issues.

parent 71bbefe1
No related branches found
No related tags found
1 merge request!35DOC: Make `make conan` more prominent.
Pipeline #19311 passed
Pipeline: caosdb-cppinttest

#19313

    ......@@ -19,6 +19,7 @@ You can print the full version of the server that you are connected to (and
    therby test the connection) via:
    .. code:: cpp
    // get version info of the server
    connection.RetrieveVersionInfo()
    const auto &v_info = connection->GetVersionInfo();
    ......@@ -57,8 +58,9 @@ you want to retrieve an Entity with id=123. This is done via
    You can then use the getter methods like :cpp:any:`GetId<caosdb::entity::Entity::GetId>`,
    :cpp:any:`GetParents<caosdb::entity::Entity::GetParents>`, or :cpp:any:`GetProperties`<caosdb::entity::Entity::GetProperties>` to get the
    name, the parents, or the properties of the retrieved entity.
    :cpp:any:`GetParents<caosdb::entity::Entity::GetParents>`, or
    :cpp:any:`GetProperties`<caosdb::entity::Entity::GetProperties>` to get the name, the parents, or
    the properties of the retrieved entity.
    Retrieving multiple entities works in the same way. Type
    ......@@ -83,9 +85,9 @@ transaction manually. This is done by
    transaction->RetrieveById("1233");
    auto status = transaction->Execute();
    A result set can be obtained
    via :cpp:any:`GetResultSet`<caosdb::transaction::Transaction::GetResultSet>` which contains the resulting entities
    and can, e.g., be checked for length.
    A result set can be obtained via
    :cpp:any:`GetResultSet`<caosdb::transaction::Transaction::GetResultSet>` which contains the
    resulting entities and can, e.g., be checked for length.
    Execute queries
    ---------------
    ......@@ -147,6 +149,7 @@ Insert, update and delete operations function the same way. The respective
    task is added to a transaction and the transaction is executed.
    .. code:: cpp
    const auto &connection =
    caosdb::connection::ConnectionManager::GetDefaultConnection();
    ......@@ -202,7 +205,7 @@ task is added to a transaction and the transaction is executed.
    Up- and Download a file
    ---------------
    -----------------------
    .. code:: cpp
    ......
    ......@@ -46,7 +46,7 @@ extensions = [
    'sphinx_sitemap',
    'sphinx.ext.inheritance_diagram',
    'breathe',
    "recommonmark" # For markdown files.
    "recommonmark", # For markdown files.
    ]
    # Add any paths that contain templates here, relative to this directory.
    ......
    0% Loading or .
    You are about to add 0 people to the discussion. Proceed with caution.
    Finish editing this message first!
    Please register or to comment