Minor documentation fixes
This commit is contained in:
Justin J. Meza
parent
465152505d
commit
93a0e9c1be
|
|
@ -292,7 +292,7 @@ void deleteScopeObject(ScopeObject *scope) /**< [in,out] The ScopeObject structu
|
|||
* \pre \a scope was created by createScopeObject(ScopeObject *) and contains
|
||||
* contents added by createScopeValue(ScopeObject *, IdentifierNode *) and
|
||||
* contents updated by updateScopeValue(ScopeObject *, IdentifierNode *, ValueObject *).
|
||||
* \pre \a target was created by createIdentifierNode(char *).
|
||||
* \pre \a target was created by createIdentifierNode(char *, const char *, unsigned int).
|
||||
*
|
||||
* \return A pointer to the stored ValueObject structure named by \a target.
|
||||
*
|
||||
|
|
@ -324,7 +324,7 @@ ValueObject *getScopeValue(ScopeObject *scope, /**< [in] The ScopeObject str
|
|||
* \pre \a scope was created by createScopeObject(ScopeObject *) and contains
|
||||
* contents added by createScopeValue(ScopeObject *, IdentifierNode *) and
|
||||
* contents updated by updateScopeValue(ScopeObject *, IdentifierNode *, ValueObject *).
|
||||
* \pre \a target was created by createIdentifierNode(char *).
|
||||
* \pre \a target was created by createIdentifierNode(char *, const char *, unsigned int).
|
||||
*
|
||||
* \return A pointer to the stored ValueObject structure named by \a target.
|
||||
*
|
||||
|
|
@ -351,7 +351,7 @@ ValueObject *getLocalScopeValue(ScopeObject *scope, /**< [in] The ScopeObjec
|
|||
* \pre \a scope was created by createScopeObject(ScopeObject *) and contains
|
||||
* contents added by createScopeValue(ScopeObject *, IdentifierNode *) and
|
||||
* contents updated by updateScopeValue(ScopeObject *, IdentifierNode *, ValueObject *).
|
||||
* \pre \a target was created by createIdentifierNode(char *).
|
||||
* \pre \a target was created by createIdentifierNode(char *, const char *, unsigned int).
|
||||
*
|
||||
* \return A pointer to the newly created ValueObject structure named by
|
||||
* \a target.
|
||||
|
|
@ -394,7 +394,7 @@ ValueObject *createScopeValue(ScopeObject *scope, /**< [in,out] The ScopeObj
|
|||
* \pre \a scope was created by createScopeObject(ScopeObject *) and contains
|
||||
* contents added by createScopeValue(ScopeObject *, IdentifierNode *) and
|
||||
* contents updated by updateScopeValue(ScopeObject *, IdentifierNode *, ValueObject *).
|
||||
* \pre \a target was created by createIdentifierNode(char *).
|
||||
* \pre \a target was created by createIdentifierNode(char *, const char *, unsigned int).
|
||||
* \pre The value named by \a target was created by createScopeValue(ScopeObject *, IdentifierNode *).
|
||||
* \pre \a value was created by either createNilValueObject(void), createBooleanValueObject(int),
|
||||
* createIntegerValueObject(int), createFloatValueObject(float), createStringValueObject(char *),
|
||||
|
|
@ -441,7 +441,7 @@ ValueObject *updateScopeValue(ScopeObject *scope, /**< [in,out] A pointer to
|
|||
* \pre \a scope was created by createScopeObject(ScopeObject *) and contains
|
||||
* contents added by createScopeValue(ScopeObject *, IdentifierNode *) and
|
||||
* contents updated by updateScopeValue(ScopeObject *, IdentifierNode *, ValueObject *).
|
||||
* \pre \a target was created by createIdentifierNode(char *).
|
||||
* \pre \a target was created by createIdentifierNode(char *, const char *, unsigned int).
|
||||
*
|
||||
* \see getScopeValue(ScopeObject *, IdentifierNode *)
|
||||
* \see getLocalScopeValue(ScopeObject *, IdentifierNode *)
|
||||
|
|
@ -1219,7 +1219,7 @@ ValueObject *interpretFuncCallExprNode(ExprNode *node, /**< [in] A pointer t
|
|||
*
|
||||
* \pre \a node was created by createExprNode(ExprType type, void *expr)
|
||||
* where \a type is ET_IDENTIFIER and \a expr is an IdentifierNode
|
||||
* structure created by createIdentifierNode(char *).
|
||||
* structure created by createIdentifierNode(char *, const char *, unsigned int).
|
||||
* \pre \a scope was created by createScopeObject(ScopeObject *) and contains
|
||||
* contents added by createScopeValue(ScopeObject *, IdentifierNode *) and
|
||||
* contents updated by updateScopeValue(ScopeObject *, IdentifierNode *, ValueObject *).
|
||||
|
|
|
|||
|
|
@ -109,6 +109,7 @@ ValueObject *getScopeValue(ScopeObject *, IdentifierNode *);
|
|||
ValueObject *getLocalScopeValue(ScopeObject *, IdentifierNode *);
|
||||
ValueObject *createScopeValue(ScopeObject *, IdentifierNode *);
|
||||
ValueObject *updateScopeValue(ScopeObject *, IdentifierNode *, ValueObject *);
|
||||
void deleteScopeValue(ScopeObject *, IdentifierNode *);
|
||||
unsigned int isNumString(const char *);
|
||||
unsigned int isHexString(const char *);
|
||||
ValueObject *castBooleanExplicit(ValueObject *, ScopeObject *);
|
||||
|
|
@ -148,6 +149,7 @@ ReturnObject *interpretSwitchStmtNode(StmtNode *, ScopeObject *);
|
|||
ReturnObject *interpretBreakStmtNode(StmtNode *, ScopeObject *);
|
||||
ReturnObject *interpretReturnStmtNode(StmtNode *, ScopeObject *);
|
||||
ReturnObject *interpretLoopStmtNode(StmtNode *, ScopeObject *);
|
||||
ReturnObject *interpretDeallocationStmtNode(StmtNode *, ScopeObject *);
|
||||
ReturnObject *interpretFuncDefStmtNode(StmtNode *, ScopeObject *);
|
||||
ReturnObject *interpretExprStmtNode(StmtNode *, ScopeObject *);
|
||||
|
||||
|
|
|
|||
36
parser.c
36
parser.c
|
|
@ -279,12 +279,12 @@ IdentifierNode *createIdentifierNode(char *image, /**< [in] An array of ch
|
|||
|
||||
/** Deletes an IdentifierNode structure.
|
||||
*
|
||||
* \pre \a node was created by createIdentifierNode(char *).
|
||||
* \pre \a node was created by createIdentifierNode(char *, const char *, unsigned int).
|
||||
*
|
||||
* \post The memory at \a node and any of its associated members will be
|
||||
* freed.
|
||||
*
|
||||
* \see createIdentifierNode(char *) */
|
||||
* \see createIdentifierNode(char *, const char *, unsigned int) */
|
||||
void deleteIdentifierNode(IdentifierNode *node) /**< [in,out] A pointer to the IdentifierNode structure to be deleted. */
|
||||
{
|
||||
if (!node) return;
|
||||
|
|
@ -315,7 +315,7 @@ IdentifierNodeList *createIdentifierNodeList(void)
|
|||
/** Adds an IdentifierNode structure to an IdentifierNodeList structure.
|
||||
*
|
||||
* \pre \a list was created by createIdentifierNodeList(void).
|
||||
* \pre \a node was created by createIdentifierNode(char *).
|
||||
* \pre \a node was created by createIdentifierNode(char *, const char *, unsigned int).
|
||||
*
|
||||
* \post \a node will be added on to the end of \a list and the size of
|
||||
* \a list will be updated accordingly.
|
||||
|
|
@ -571,7 +571,7 @@ void deleteStmtNodeList(StmtNodeList *list) /**< [in,out] A pointer to the StmtN
|
|||
|
||||
/** Creates a CastStmtNode structure.
|
||||
*
|
||||
* \pre \a target was created by createIdentifierNode(char *).
|
||||
* \pre \a target was created by createIdentifierNode(char *, const char *, unsigned int).
|
||||
* \pre \a newtype was created by createTypeNode(ConstantType).
|
||||
*
|
||||
* \return A pointer to a CastStmtNode structure with the desired properties.
|
||||
|
|
@ -648,7 +648,7 @@ void deletePrintStmtNode(PrintStmtNode *node) /**< [in,out] A pointer to the Pri
|
|||
|
||||
/** Creates an InputStmtNode structure.
|
||||
*
|
||||
* \pre \a target was created by createIdentifierNode(char *).
|
||||
* \pre \a target was created by createIdentifierNode(char *, const char *, unsigned int).
|
||||
*
|
||||
* \return A pointer to an InputStmtNode structure with the desired properties.
|
||||
*
|
||||
|
|
@ -683,7 +683,7 @@ void deleteInputStmtNode(InputStmtNode *node) /**< [in,out] A pointer to the Inp
|
|||
|
||||
/** Creates an AssignmentStmtNode structure.
|
||||
*
|
||||
* \pre \a target was created by createIdentifierNode(char *).
|
||||
* \pre \a target was created by createIdentifierNode(char *, const char *, unsigned int).
|
||||
* \pre \a expr was created by createExprNode(ExprType, void *).
|
||||
*
|
||||
* \return A pointer to an AssignmentStmtNode structure with the desired
|
||||
|
|
@ -723,8 +723,8 @@ void deleteAssignmentStmtNode(AssignmentStmtNode *node) /**< [in,out] A pointer
|
|||
|
||||
/** Creates a DeclarationStmtNode structure.
|
||||
*
|
||||
* \pre \a scope was created by createIdentifierNode(char *).
|
||||
* \pre \a target was created by createIdentifierNode(char *).
|
||||
* \pre \a scope was created by createIdentifierNode(char *, const char *, unsigned int).
|
||||
* \pre \a target was created by createIdentifierNode(char *, const char *, unsigned int).
|
||||
* \pre \a expr was created by createExprNode(ExprType, void *).
|
||||
*
|
||||
* \return A pointer to a DeclarationStmtNode structure with the desired
|
||||
|
|
@ -900,8 +900,8 @@ void deleteReturnStmtNode(ReturnStmtNode *node) /**< [in,out] A pointer to the R
|
|||
|
||||
/** Creates a LoopStmtNode structure.
|
||||
*
|
||||
* \pre \a name was created by createIdentifierNode(char *).
|
||||
* \pre \a var was created by createIdentifierNode(char *).
|
||||
* \pre \a name was created by createIdentifierNode(char *, const char *, unsigned int).
|
||||
* \pre \a var was created by createIdentifierNode(char *, const char *, unsigned int).
|
||||
* \pre \a guard was created by createExprNode(ExprType, void *).
|
||||
* \pre \a update was created by createExprNode(ExprType, void *).
|
||||
* \pre \a body was created by createBlockNode(StmtNodeList *).
|
||||
|
|
@ -951,7 +951,7 @@ void deleteLoopStmtNode(LoopStmtNode *node) /**< [in,out] A pointer to the LoopS
|
|||
|
||||
/** Creates a DeallocationStmtNode structure.
|
||||
*
|
||||
* \pre \a target was created by createIdentifierNode(char *).
|
||||
* \pre \a target was created by createIdentifierNode(char *, const char *, unsigned int).
|
||||
*
|
||||
* \return A pointer to a DeallocationStmtNode structure with the desired
|
||||
* properties.
|
||||
|
|
@ -987,8 +987,8 @@ void deleteDeallocationStmtNode(DeallocationStmtNode *node) /**< [in,out] A poin
|
|||
|
||||
/** Creates a FuncDefStmtNode structure.
|
||||
*
|
||||
* \pre \a scope was created by createIdentifierNode(char *).
|
||||
* \pre \a name was created by createIdentifierNode(char *).
|
||||
* \pre \a scope was created by createIdentifierNode(char *, const char *, unsigned int).
|
||||
* \pre \a name was created by createIdentifierNode(char *, const char *, unsigned int).
|
||||
* \pre \a args was created by createIdentifierNodeList(void) and contains
|
||||
* items added by addIdentifierNode(IdentifierNodeList *, IdentifierNode *).
|
||||
* \pre \a body was created by createBlockNode(StmtNodeList *).
|
||||
|
|
@ -1039,9 +1039,9 @@ void deleteFuncDefStmtNode(FuncDefStmtNode *node) /**< [in,out] A pointer to the
|
|||
* \pre \a expr contains a structure created corresponding to \a type:
|
||||
* - ET_CAST: createCastExprNode(ExprNode *, TypeNode *)
|
||||
* - ET_CONSTANT: createBooleanConstantNode(int), createIntegerConstantNode(int),
|
||||
* createFloatConstantNode(float), or createStringConstantNode(char *).
|
||||
* - ET_IDENTIFIER: createIdentifierNode(char *)
|
||||
* - ET_FUNCCALL: createFuncCallExprNode(FuncDefStmtNode *, ExprNodeList *)
|
||||
* createFloatConstantNode(float), or createStringConstantNode(char *)
|
||||
* - ET_IDENTIFIER: createIdentifierNode(char *, const char *, unsigned int)
|
||||
* - ET_FUNCCALL: createFuncCallExprNode(IdentifierNode *, IdentifierNode *, ExprNodeList *)
|
||||
* - ET_OP: createOpExprNode(OpType, ExprNodeList *)
|
||||
* - ET_IMPVAR: (for the \ref impvar "implicit variable") no structure needed, use \c NULL
|
||||
*
|
||||
|
|
@ -1205,8 +1205,8 @@ void deleteCastExprNode(CastExprNode *node) /**< [in,out] A pointer to the CastE
|
|||
|
||||
/** Creates a FuncCallExprNode structure.
|
||||
*
|
||||
* \pre \a scope was created by createIdentifierNode(char *).
|
||||
* \pre \a name was created by createIdentifierNode(char *).
|
||||
* \pre \a scope was created by createIdentifierNode(char *, const char *, unsigned int).
|
||||
* \pre \a name was created by createIdentifierNode(char *, const char *, unsigned int).
|
||||
* \pre \a args was created by createIdentifierNodeList(void) and contains
|
||||
* items added by addIdentifierNode(IdentifierNodeList *, IdentifierNode *).
|
||||
*
|
||||
|
|
|
|||
|
|
@ -171,7 +171,7 @@ Token *addToken(Token ***list, /**< [in,out] A pointer to a pointer to an ar
|
|||
|
||||
/** Deletes an array of Token structures.
|
||||
*
|
||||
* \pre \a list was created by and contains items added by addToken(Token ***, unsigned int *, TokenType, const char *, unsigned int).
|
||||
* \pre \a list was created by and contains items added by addToken(Token ***, unsigned int *, Token *).
|
||||
*
|
||||
* \post The memory at \a list and all of its elements will be freed.
|
||||
*
|
||||
|
|
|
|||
Loading…
Reference in New Issue