1  /* mcComment interface to comment module.
       2  
       3  Copyright (C) 2018-2023 Free Software Foundation, Inc.
       4  Contributed by Gaius Mulley <gaius@glam.ac.uk>.
       5  
       6  This file is part of GNU Modula-2.
       7  
       8  GNU Modula-2 is free software; you can redistribute it and/or modify
       9  it under the terms of the GNU General Public License as published by
      10  the Free Software Foundation; either version 3, or (at your option)
      11  any later version.
      12  
      13  GNU Modula-2 is distributed in the hope that it will be useful, but
      14  WITHOUT ANY WARRANTY; without even the implied warranty of
      15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
      16  General Public License for more details.
      17  
      18  You should have received a copy of the GNU General Public License
      19  along with GNU Modula-2; see the file COPYING3.  If not see
      20  <http://www.gnu.org/licenses/>.  */
      21  
      22  #ifndef mcCommentH
      23  #define mcCommentH
      24  
      25  /* addText the text cs is appended to the current comment.  */
      26  
      27  extern void mcComment_addText (void *cd, char *cs);
      28  
      29  
      30  /* initComment the start of a new comment has been seen by the lexical analyser.
      31     A new comment block is created and all addText contents are placed
      32     in this block.  onlySpaces indicates whether we have only seen
      33     spaces on this line.  The new comment descriptor is returned.
      34     If onlySpaces is TRUE then an inbody comment is created.
      35     If onlySpaces is FALSE then an after statement comment is created.  */
      36  
      37  extern void *mcComment_initComment (unsigned int onlySpaces);
      38  
      39  
      40  #endif