ROSE  0.9.9.109
SgBreakStatement.docs
1 // Documentation for class SgBreakStatement
4 
27 // Documentation for class SgBreakStatement data members
30 
36 // Documentation for class SgBreakStatement member functions (methods)
39 /*
40 \fn SgBreakStmt::copy(const SgCopyHelp & help ) const
41 \brief This function clones the current SgBreakStmt object recursively or not, depending on the argument
42 // \brief Copies an existing SgBreakStmt.
43 
44 This function performs a copy based on the specification of the input parameter.
45 The input parameter is used to determin which data members are copied by reference
46 and which are copied by value.
47 
48 \param help - If this argument is of type SgTreeCopy, then the
49 SgInitializedName is cloned recursively. If it's of type SgShallowCopy
50 only the first level of SgInitializedName is copied, everything else
51 pointing to the the original SgInitializedName object's data members.
52 \return a pointer to the new clone.
53 
54 \exception none No exceptions are thrown by this function.
55 */
56 
76 /*
77 \fn SgBreakStmt::sage_class_name() const
78 \brief generates string: "SgBreakStmt"
79 
80 This function is useful for debugging and error reporting. It
81 returns the name of the IR node.
82 
83 \return a char* pointer to a C style string.
84 */
85 
86 /*
87 \fn SgBreakStmt::variant()
88 \brief Older version function returns enum value "BREAK_STMT"
89 
90 This function is an older version of the variant function.
91 This function is useful for debugging and error reporting. It
92 returns the name of the IR node.
93 
94 \return an enum value.
95 \deprecated Use Tvariant() instead. Older enum values have inconsistant
96 names and are being removed.
97 */
98 
99 /*
100 \fn SgBreakStmt::variantT()
101 \brief returns enum value "V_SgBreakStmt"
102 
103 This function is useful for debugging and error reporting. It
104 returns the name of the IR node.
105 
106 \return an enum value.
107 \deprecated Use Tvariant() instead. Older enum values have inconsistant
108 names and are being removed.
109 */
110 
111 /*
112 \fn SgBreakStmt::error()
113 \brief tests for internal errors ???
114 
115 
116 \return Returns bool; true if there is an error, and false if OK.
117 */
118 
119 
120