obitools/obitools3
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 66 Wiki Activity

Added comments about listing columns and indexers in obidms functions

Browse Source
This commit is contained in:
Celine Mercier
2016-04-29 16:06:01 +02:00
parent 9fe21316ff
commit 5bd12079ae
2 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/obidms.h
View File

@ -230,6 +230,8 @@ OBIDMS_column_p obi_dms_get_column_from_list(OBIDMS_p dms, const char* column_na
/**
* @brief Adds a column identified by its name and its version number in the list of opened columns.
*
* @warning obi_dms_get_column_from_list() should be used first to check if the column isn't already listed.
*
* @param dms The OBIDMS.
* @param column A pointer on the column that should be added in the list of opened columns.
*
@ -269,6 +271,8 @@ Obi_indexer_p obi_dms_get_indexer_from_list(OBIDMS_p dms, const char* indexer_na
/**
* @brief Adds an indexer identified by its name in the list of opened indexers.
*
* @warning obi_dms_get_indexer_from_list() should be used first to check if the indexer isn't already listed.
*
* @param dms The OBIDMS.
* @param indexer A pointer on the indexer that should be added in the list of opened indexers.
*