Commit bb25723d by Celine Mercier

Improved documentation of a function

parent a0da9840
......@@ -74,7 +74,7 @@ typedef struct Obiview_infos {
*/
size_t used_size; /**< Used size in bytes.
*/
time_t creation_date; /**< Time at which the view was written in the view file.
time_t creation_date; /**< Time at which the view was created.
*/
char name[OBIVIEW_NAME_MAX_LENGTH+1]; /**< Name of the view, used to identify it.
*/
......@@ -140,6 +140,7 @@ typedef struct Obiview {
* @param view_to_clone Eventually a pointer on the opened view to clone to create the new one, if there is one. NULL if not.
* @param line_selection Eventually a pointer on a list of indexes corresponding to a line selection to use with the view to clone
* if there is one. NULL if there is no line selection or no view to clone.
* The end of the index array is flagged by a -1 value.
* @param comments Eventually, comments to associate with the view. NULL if not.
*
* @returns A pointer to the newly created view structure.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment