/**
* Adds the specified value to this enum.
*
- * @param name enum value name
* @param value optional numerical value
*/
public void add_value (CCodeEnumValue value) {
* Writes the public interface of the specified code context into the
* specified file.
*
- * @param context a code context
- * @param filename a relative or absolute filename
+ * @param context a code context
+ * @param gir_filename a relative or absolute filename
*/
public void write_file (CodeContext context, string directory, string gir_filename, string gir_namespace, string gir_version, string package, string? gir_shared_library = null) {
this.context = context;
/**
* Adds an attribute argument.
*
- * @param arg named argument
+ * @param key argument name
+ * @param value argument value
*/
public void add_argument (string key, string value) {
args.set (key, value);
/**
* Creates a new binary expression.
*
- * @param op binary operator
- * @param left left operand
- * @param right right operand
- * @param source reference to source code
- * @return newly created binary expression
+ * @param op binary operator
+ * @param _left left operand
+ * @param _right right operand
+ * @param source reference to source code
+ * @return newly created binary expression
*/
public BinaryExpression (BinaryOperator op, Expression _left, Expression _right, SourceReference? source = null) {
operator = op;
/**
* Creates a new block.
*
- * @param source reference to source code
+ * @param source_reference reference to source code
*/
public Block (SourceReference? source_reference) {
base (null, source_reference);
/**
* Add a local variable to this block.
*
- * @param decl a variable declarator
+ * @param local a variable declarator
*/
public void add_local_variable (LocalVariable local) {
var parent_block = parent_symbol;
/**
* Creates a new cast expression.
*
- * @param inner expression to be cast
- * @param type target type
- * @return newly created cast expression
+ * @param inner expression to be cast
+ * @param type_reference target type
+ * @return newly created cast expression
*/
public CastExpression (Expression inner, DataType type_reference, SourceReference source_reference, bool is_silent_cast) {
this.type_reference = type_reference;
private LocalVariable _error_variable;
/**
- * Creates a new catch
+ * Creates a new catch
*
- * @param type_reference error type
+ * @param error_type error type
* @param variable_name error variable name
* @param body error handler body
* @param source_reference reference to source code
/**
* Creates a new class.
*
- * @param name type name
- * @param source reference to source code
- * @param comment class documentation
- * @return newly created class
+ * @param name type name
+ * @param source_reference reference to source code
+ * @param comment class documentation
+ * @return newly created class
*/
public Class (string name, SourceReference? source_reference = null, Comment? comment = null) {
base (name, source_reference, comment);
/**
* The root namespace of the symbol tree.
- *
- * @return root namespace
*/
public Namespace root {
get { return _root; }
/**
* Creates a new declaration statement.
*
- * @param decl local variable declaration
- * @param source reference to source code
- * @return newly created declaration statement
+ * @param declaration local variable declaration
+ * @param source_reference reference to source code
+ * @return newly created declaration statement
*/
public DeclarationStatement (Symbol declaration, SourceReference? source_reference) {
this.declaration = declaration;
/**
* Creates a new delegate.
*
- * @param name delegate type name
- * @param return_type return type
- * @param source reference to source code
- * @return newly created delegate
+ * @param name delegate type name
+ * @param return_type return type
+ * @param source_reference reference to source code
+ * @return newly created delegate
*/
public Delegate (string? name, DataType return_type, SourceReference? source_reference = null, Comment? comment = null) {
base (name, source_reference, comment);
/**
* Creates a new do statement.
*
- * @param cond loop condition
- * @param body loop body
- * @param source reference to source code
- * @return newly created do statement
+ * @param body loop body
+ * @param condition loop condition
+ * @param source_reference reference to source code
+ * @return newly created do statement
*/
public DoStatement (Block body, Expression condition, SourceReference? source_reference = null) {
this.condition = condition;
/**
* Creates a new expression statement.
*
- * @param expr expression to evaluate
- * @param source reference to source code
- * @return newly created expression statement
+ * @param expression expression to evaluate
+ * @param source_reference reference to source code
+ * @return newly created expression statement
*/
public ExpressionStatement (Expression expression, SourceReference? source_reference = null) {
this.source_reference = source_reference;
/**
* Creates a new field.
*
- * @param name field name
- * @param type field type
- * @param init initializer expression
- * @param source reference to source code
- * @return newly created field
+ * @param name field name
+ * @param variable_type field type
+ * @param initializer initializer expression
+ * @param source_reference reference to source code
+ * @return newly created field
*/
public Field (string name, DataType variable_type, Expression? initializer, SourceReference? source_reference = null, Comment? comment = null) {
base (variable_type, name, initializer, source_reference, comment);
/**
* Creates a new foreach statement.
*
- * @param type element type
- * @param id element variable name
- * @param col loop body
- * @param source reference to source code
- * @return newly created foreach statement
+ * @param type_reference element type
+ * @param variable_name element variable name
+ * @param collection container
+ * @param body loop body
+ * @param source_reference reference to source code
+ * @return newly created foreach statement
*/
public ForeachStatement (DataType? type_reference, string variable_name, Expression collection, Block body, SourceReference source_reference) {
base (source_reference);
/**
* Creates a new for statement.
*
- * @param cond loop condition
+ * @param condition loop condition
* @param body loop body
* @param source_reference reference to source code
* @return newly created for statement
/**
* Creates a new interface.
*
- * @param name type name
- * @param source reference to source code
- * @return newly created interface
+ * @param name type name
+ * @param source_reference reference to source code
+ * @return newly created interface
*/
public Interface (string name, SourceReference? source_reference = null, Comment? comment = null) {
base (name, source_reference, comment);
/**
* Creates a new local variable.
*
- * @param name name of the variable
- * @param init optional initializer expression
- * @param source reference to source code
- * @return newly created variable declarator
+ * @param name name of the variable
+ * @param initializer optional initializer expression
+ * @param source_reference reference to source code
+ * @return newly created variable declarator
*/
public LocalVariable (DataType? variable_type, string name, Expression? initializer = null, SourceReference? source_reference = null) {
base (variable_type, name, initializer, source_reference);
/**
* Creates a new loop.
*
- * @param body loop body
- * @param source reference to source code
- * @return newly created while statement
+ * @param body loop body
+ * @param source_reference reference to source code
+ * @return newly created while statement
*/
public Loop (Block body, SourceReference? source_reference = null) {
this.body = body;
/**
* Creates a new method.
*
- * @param name method name
- * @param return_type method return type
- * @param source reference to source code
- * @return newly created method
+ * @param name method name
+ * @param return_type method return type
+ * @param source_reference reference to source code
+ * @return newly created method
*/
public Method (string? name, DataType return_type, SourceReference? source_reference = null, Comment? comment = null) {
base (name, source_reference, comment);
/**
* Creates a new formal parameter.
*
- * @param name parameter name
- * @param type parameter type
- * @param source reference to source code
- * @return newly created formal parameter
+ * @param name parameter name
+ * @param variable_type parameter type
+ * @param source_reference reference to source code
+ * @return newly created formal parameter
*/
public Parameter (string name, DataType? variable_type, SourceReference? source_reference = null) {
base (variable_type, name, null, source_reference);
/**
* Creates a new postfix expression.
*
- * @param inner operand expression
- * @param inc true for increment, false for decrement
- * @param source reference to source code
- * @return newly created postfix expression
+ * @param _inner operand expression
+ * @param inc true for increment, false for decrement
+ * @param source reference to source code
+ * @return newly created postfix expression
*/
public PostfixExpression (Expression _inner, bool inc, SourceReference source) {
inner = _inner;
/**
* Creates a new property.
*
- * @param name property name
- * @param type property type
- * @param get_accessor get accessor
- * @param set_accessor set/construct accessor
- * @param source reference to source code
- * @return newly created property
+ * @param name property name
+ * @param property_type property type
+ * @param get_accessor get accessor
+ * @param set_accessor set/construct accessor
+ * @param source_reference reference to source code
+ * @return newly created property
*/
public Property (string name, DataType? property_type, PropertyAccessor? get_accessor, PropertyAccessor? set_accessor, SourceReference? source_reference = null, Comment? comment = null) {
base (name, source_reference, comment);
/**
* Creates a new property accessor.
*
- * @param readable true if get accessor, false otherwise
- * @param writable true if set accessor, false otherwise
- * @param construction true if construct accessor, false otherwise
- * @param body accessor body
- * @param source reference to source code
- * @return newly created property accessor
+ * @param readable true if get accessor, false otherwise
+ * @param writable true if set accessor, false otherwise
+ * @param construction true if construct accessor, false otherwise
+ * @param body accessor body
+ * @param source_reference reference to source code
+ * @return newly created property accessor
*/
public PropertyAccessor (bool readable, bool writable, bool construction, DataType? value_type, Block? body, SourceReference? source_reference, Comment? comment = null) {
base (null, source_reference, comment);
/**
* Creates a new regular expression literal.
*
- * @param s the literal value
- * @param source reference to source code
- * @return newly created string literal
+ * @param value the literal value
+ * @param source_reference reference to source code
+ * @return newly created string literal
*/
public RegexLiteral (string value, SourceReference? source_reference = null) {
this.value = value;
/**
* Creates a new signal.
*
- * @param name signal name
- * @param return_type signal return type
- * @param source reference to source code
- * @return newly created signal
+ * @param name signal name
+ * @param return_type signal return type
+ * @param source_reference reference to source code
+ * @return newly created signal
*/
public Signal (string name, DataType return_type, SourceReference? source_reference = null, Comment? comment = null) {
base (name, source_reference, comment);
* Creates a new source file.
*
* @param filename source file name
- * @param pkg true if this is a VAPI package file
* @return newly created source file
*/
public SourceFile (CodeContext context, SourceFileType type, string filename, string? content = null, bool cmdline = false) {
/**
* Creates a new source reference.
*
- * @param file a source file
- * @param first_line first line number
- * @param first_column first column number
- * @param last_line last line number
- * @param last_column last column number
+ * @param _file a source file
+ * @param begin the begin of the referenced source code
+ * @param end the end of the referenced source code
* @return newly created source reference
*/
public SourceReference (SourceFile _file, SourceLocation begin, SourceLocation end) {
/**
* Creates a new string literal.
*
- * @param s the literal value
- * @param source reference to source code
- * @return newly created string literal
+ * @param value the literal value
+ * @param source_reference reference to source code
+ * @return newly created string literal
*/
public StringLiteral (string value, SourceReference? source_reference = null) {
this.value = value;
/**
* Sets the rank of this integer or floating point type.
- *
- * @return the rank if this is an integer or floating point type
*/
public void set_rank (int rank) {
this.rank = rank;
/**
* Creates a new generic type parameter.
*
- * @param name parameter name
- * @param source reference to source code
- * @return newly created generic type parameter
- */
+ * @param name parameter name
+ * @param source_reference reference to source code
+ * @return newly created generic type parameter
+ */
public TypeParameter (string name, SourceReference source_reference) {
base (name, source_reference);
}
* Creates a new unary expression.
*
* @param op unary operator
- * @param inner operand
+ * @param _inner operand
* @param source reference to source code
* @return newly created binary expression
*/
/**
* Creates a new while statement.
*
- * @param cond loop condition
- * @param body loop body
- * @param source reference to source code
- * @return newly created while statement
+ * @param condition loop condition
+ * @param body loop body
+ * @param source_reference reference to source code
+ * @return newly created while statement
*/
public WhileStatement (Expression condition, Block body, SourceReference? source_reference = null) {
this.body = body;
projects / thirdparty / vala.git / commitdiff
