Project

General

Profile

« Previous | Next » 

Revision 2596

Added by stephane almost 14 years ago

UTILS_G
- GBase : documentations

View differences:

scol_gbase.c
1
/*! \file scol_gbase.c
2
*	\brief all functions of this API
3
*   \author Stephane Bisaro
4
*/
1 5
/*
2 6
This source file is part of Scol
3 7
For the latest info, see http://www.scolring.org
......
21 25
For others informations, please contact us from http://www.scolring.org/
22 26
*/
23 27

  
24
#include "../include/scol_gbase.h"
28
#include "../include/scol_gbase.h"
29

  
30
#ifdef __cplusplus
31
#error This source file is not C++ but rather C. Please use a C-compiler
32
#endif
25 33

  
26 34
#if ((defined _WIN32) || (defined __WIN32__))
27 35
cbmachine ww;
......
82 90
 * fun [] S
83 91
 *
84 92
 * \param : nothing
85
 * \return S : this directory
93
 * \return S : this directory or "unknown" if undefined
86 94
 */
87 95
int SCOL_gBaseDirCur (mmachine m)
88 96
{
......
179 187
 * fun [[S r1] I] S
180 188
 *
181 189
 * \param [S r1] : a list of elements (typically, a list of directory : a :: b :: c :: file.ext)
182
 * \param I : 1 : OS separator, otherwise Scol separator (/)
190
 * \param I : 1 : OS separator (e.g. "\" on MS Windows, "/" on Linux), otherwise Scol separator ("/")
183 191
 * \return S : the filename
184 192
 */
185 193
int SCOL_gBasePathBuild (mmachine m)
......
228 236
 * fun [S I] S
229 237
 *
230 238
 * \param S : any string
231
 * \param I : 1 to UTF8, 0 to current locale
239
 * \param I : 1 from locale to UTF8, 0 from UTF-8 to current locale
232 240
 * \return : the new string
233 241
 */
234 242
int SCOL_gBaseStringUTF8 (mmachine m)
......
417 425
 * \brief _gbaseIsIp : Tests if a string is a form of an IPv4 or IPv6 address (like "123.210.012.231").
418 426
 * fun [S] I
419 427
 * \param S : any string
420
 * \return I : 1 if TRUE, 0 if FALSE
428
 * \return I : 1 if TRUE (the string is an IP address), 0 if FALSE
421 429
 */
422 430
int SCOL_gbaseIsIp (mmachine m)
423 431
{
......
519 527
}
520 528

  
521 529

  
522
/**
523
 * \brief Load and free the regular expression library
530
/*
531
 * Load and free the regular expression library
524 532
 * Plateforms supported : MS Windows and GNU / Linux
525 533
 */
526 534

  

Also available in: Unified diff