libvaladoc/api/girsourcecomment.vala

   1 /* sourcecomment.vala
   2  *
   3  * Copyright (C) 2011  Florian Brosch
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
  18  *
  19  * Author:
  20  *      Florian Brosch <flo.brosch@gmail.com>
  21  */
  22
  23
  24 /**
  25  * A documentation comment used by valadoc
  26  */
  27 public class Valadoc.Api.GirSourceComment : SourceComment {
  28         private Vala.Map<string, SourceComment> parameters = new Vala.HashMap<string, SourceComment> (str_hash, str_equal);
  29
  30         public string? instance_param_name { set; get; }
  31         public SourceComment? return_comment { set; get; }
  32         public SourceComment? deprecated_comment { set; get; }
  33         public SourceComment? version_comment { get; set; }
  34         public SourceComment? stability_comment { get; set; }
  35
  36
  37         public Vala.MapIterator<string, SourceComment> parameter_iterator () {
  38                 return parameters.map_iterator ();
  39         }
  40
  41         public void add_parameter_content (string param_name, SourceComment comment) {
  42                 this.parameters.set (param_name, comment);
  43         }
  44
  45         public SourceComment? get_parameter_comment (string param_name) {
  46                 if (parameters == null) {
  47                         return null;
  48                 }
  49
  50                 return parameters.get (param_name);
  51         }
  52
  53         public GirSourceComment (string content, SourceFile file, int first_line, int first_column, int last_line, int last_column) {
  54                 base (content, file, first_line, first_column, last_line, last_column);
  55         }
  56 }
  57