sml/doccodes.h File Reference

#include <mi32/mistring.h>
#include <sml/usage.h>
Include dependency graph for doccodes.h:

Go to the source code of this file.

Classes

class  SML::DOCCODES
 class SML::DOCCODES More...
class  SML::DOCCODES_ANSI
 Pass to SML::GetFuncDoc() to get plain text with ANSI codes for bold, color, etc. More...
class  SML::DOCCODES_HTML
 Pass to SML::GetFuncDoc() to get HTML text. More...
class  SML::DOCCODES_MISTRING
 An intermediate class that SML::DOCCODES_ANSI and SML::DOCCODES_HTML are based on. More...

Namespaces

namespace  SML

Defines

#define BackgroundReadSMLDOCS   SML::BackgroundReadSMLDOCS
#define SML_GetClassDesc   SML::GetClassDesc
#define SML_GetClassDoc   SML::GetClassDoc
#define SML_GetExampleDoc   SML::GetExampleDoc
#define SML_GetExampleDoc   SML::GetExampleDoc
#define SML_GetFuncDesc   SML::GetFuncDesc
#define SML_GetFuncDoc   SML::GetFuncDoc
#define SML_GetFuncExample   SML::GetFuncExample
#define SML_GetKeywordDesc   SML::GetKeywordDesc
#define SML_GetKeywordDoc   SML::GetKeywordDoc
#define SML_GetKeywordList   SML::GetKeywordList
#define SML_GetOperatorDesc   SML::GetOperatorDesc
#define SML_GetOperatorDoc   SML::GetOperatorDoc
#define SML_GetOperatorList   SML::GetOperatorList
#define SML_GetSMLDOCS   SML::GetSMLDOCS

Functions

void SML::BackgroundReadSMLDOCS ()
bool SML::GetClassDesc (CONTEXT *context, const MISTRING &ClassName, MISTRING &mistr)
int SML::GetClassDoc (CONTEXT *context, const CLASS *Class, DOCCODES &codes, bool bInsert=false, USAGE usage=USAGE_Undefined)
int SML::GetExampleDoc (XMLNODE *node, DOCCODES &codes)
int SML::GetExampleDoc (const MISTRING &name, DOCCODES &codes)
bool SML::GetFuncDesc (CONTEXT *context, const FUNC *smlfunc, MISTRING &mistr)
int SML::GetFuncDoc (CONTEXT *context, USAGE Usage, const SYMBOL *sym, DOCCODES &codes, bool bShortForm=false)
int SML::GetFuncExample (CONTEXT *context, const SYMBOL *sym, MISTRING &mistr)
bool SML::GetKeywordDesc (const char *keyword, MISTRING &desc)
int SML::GetKeywordDoc (const char *keyword, DOCCODES &codes)
const char *const * SML::GetKeywordList ()
bool SML::GetOperatorDesc (const char *op, MISTRING &desc)
int SML::GetOperatorDoc (const char *op, DOCCODES &codes)
const char *const * SML::GetOperatorList ()
XMLNODESML::GetSMLDOCS (bool bInBackground=false)
int SML::SearchDocs (CONTEXT *context, const MISTRING &SearchStr, DOCCODES &doc, MISTATUSCONTEXT &StatusContext)
ERRVALUE SML::UpdateDocs (const FILEPATH &docspath, SML::CONTEXT *context)

Define Documentation

#define BackgroundReadSMLDOCS   SML::BackgroundReadSMLDOCS
#define SML_GetClassDesc   SML::GetClassDesc
#define SML_GetClassDoc   SML::GetClassDoc
#define SML_GetExampleDoc   SML::GetExampleDoc
#define SML_GetExampleDoc   SML::GetExampleDoc
#define SML_GetFuncDesc   SML::GetFuncDesc
#define SML_GetFuncDoc   SML::GetFuncDoc
#define SML_GetFuncExample   SML::GetFuncExample
#define SML_GetKeywordDesc   SML::GetKeywordDesc
#define SML_GetKeywordDoc   SML::GetKeywordDoc
#define SML_GetKeywordList   SML::GetKeywordList
#define SML_GetOperatorDesc   SML::GetOperatorDesc
#define SML_GetOperatorDoc   SML::GetOperatorDoc
#define SML_GetOperatorList   SML::GetOperatorList
#define SML_GetSMLDOCS   SML::GetSMLDOCS

Generated on Sun Oct 7 21:31:38 2012 for TNTsdk 2012 by  doxygen 1.6.1