Added documentation

This commit is contained in:
goldsimon 2009-11-01 20:58:22 +00:00
parent 1a265b5373
commit b9113fe615

View File

@ -36,18 +36,19 @@
#include <string.h> #include <string.h>
/*-----------------------------------------------------------------------------------*/ /** Search for a file by its full name and return pointer and length if found.
*
* @param name full file name as passed in HTTP request
/*-----------------------------------------------------------------------------------*/ * @param file structure that must be allocated by caller and will be filled in
* by the function if the filename was found.
* @return 1 if the file was found, 0 if the file was not found
*/
int int
fs_open(const char *name, struct fs_file *file) fs_open(const char *name, struct fs_file *file)
{ {
const struct fsdata_file *f; const struct fsdata_file *f;
for(f = FS_ROOT; for (f = FS_ROOT; f != NULL; f = f->next) {
f != NULL;
f = f->next) {
if (!strcmp(name, (const char*)f->name)) { if (!strcmp(name, (const char*)f->name)) {
file->data = f->data; file->data = f->data;
file->len = f->len; file->len = f->len;
@ -56,4 +57,3 @@ fs_open(const char *name, struct fs_file *file)
} }
return 0; return 0;
} }
/*-----------------------------------------------------------------------------------*/