doc is in doxygen files

doc/doxygen/chapters/api/data_out_of_core.doxy

@@ -7,13 +7,23 @@
 
 /*! \defgroup API_Out_Of_Core Out Of Core
 
-
-
 \struct starpu_disk_ops
 \ingroup API_Out_Of_Core
 This is a set of functions to manipulate datas on disk.
-
-\fn int starpu_disk_register(struct starpu_disk_ops *func, void *parameter, size_t size) 
+\var starpu_disk_ops::alloc
+\var starpu_disk_ops::free
+\var starpu_disk_ops::open
+open an existing file
+\var starpu_disk_ops::close
+\var starpu_disk_ops::read
+~= pread
+\var starpu_disk_ops::write
+\var starpu_disk_ops::plug
+\var starpu_disk_ops::unplug
+\var starpu_disk_ops::copy
+\var starpu_disk_ops::bandwidth
+
+\fn int starpu_disk_register(struct starpu_disk_ops *func, void *parameter, size_t size)
 \ingroup API_Out_Of_Core
 Register a disk memory node with a set of functions to manipulate datas. <br />
 SUCCESS: return the disk node. <br />

include/starpu_disk.h

@@ -18,33 +18,29 @@
 #ifndef __STARPU_DISK_H__
 #define __STARPU_DISK_H__
 
-/* list of functions to use on disk */
-struct starpu_disk_ops {
- 	 void *  (*alloc)  (void *base, size_t size);
-	 void    (*free)   (void *base, void *obj, size_t size);
-	 void *  (*open)   (void *base, void *pos, size_t size);     /* open an existing file */
-	 void    (*close)  (void *base, void *obj, size_t size);
-	ssize_t  (*read)   (void *base, void *obj, void *buf, off_t offset, size_t size);        /* ~= pread */
-	ssize_t  (*write)  (void *base, void *obj, const void *buf, off_t offset, size_t size); 
-	/* readv, writev, read2d, write2d, etc. */
-	 void *  (*plug)   (void *parameter);
-	 void    (*unplug) (void *base);
-	  int    (*copy)   (void *base_src, void* obj_src, off_t offset_src,  void *base_dst, void* obj_dst, off_t offset_dst, size_t size);
-	  int    (*bandwidth) (unsigned node);
+struct starpu_disk_ops
+{
+	void *  (*alloc)  (void *base, size_t size);
+	void    (*free)   (void *base, void *obj, size_t size);
+	void *  (*open)   (void *base, void *pos, size_t size);
+	void    (*close)  (void *base, void *obj, size_t size);
+	ssize_t  (*read)   (void *base, void *obj, void *buf, off_t offset, size_t size);
+	ssize_t  (*write)  (void *base, void *obj, const void *buf, off_t offset, size_t size);
+	void *  (*plug)   (void *parameter);
+	void    (*unplug) (void *base);
+	int    (*copy)   (void *base_src, void* obj_src, off_t offset_src,  void *base_dst, void* obj_dst, off_t offset_dst, size_t size);
+	int    (*bandwidth) (unsigned node);
 };
 
-
 /* Posix functions to use disk memory */
 extern struct starpu_disk_ops starpu_disk_stdio_ops;
 extern struct starpu_disk_ops starpu_disk_unistd_ops;
 extern struct starpu_disk_ops starpu_disk_unistd_o_direct_ops;
 
-/*functions to add an existing memory */
 void starpu_disk_close(unsigned node, void *obj, size_t size);
 
 void * starpu_disk_open(unsigned node, void *pos, size_t size);
 
-/* interface to create and to free a memory disk */
 int starpu_disk_register(struct starpu_disk_ops * func, void *parameter, size_t size);
 
 #endif /* __STARPU_DISK_H__ */