vala/valacomment.vala

   1 /* valacomment.vala
   2  *
   3  * Copyright (C) 2008-2009  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 using GLib;
  24
  25 /**
  26  * A documentation comment used by valadoc
  27  */
  28 public class Vala.Comment {
  29         public Comment (string comment, SourceReference _source_reference) {
  30                 source_reference = _source_reference;
  31                 content = comment;
  32         }
  33
  34         /**
  35          * The text describing the referenced source code.
  36          */
  37         public string content { set; get; }
  38
  39         /**
  40          * References the location in the source file where this code node has
  41          * been written.
  42          */
  43         public SourceReference source_reference { get; set; }
  44 }
  45