chiark - git - mdw - mLib/blob - test/example/example.h

   1 /* -*-c-*-
   2  *
   3  * Example test program
   4  *
   5  * (c) 2024 Straylight/Edgeware
   6  */
   7
   8 /*----- Licensing notice --------------------------------------------------*
   9  *
  10  * This file is part of the mLib utilities library.
  11  *
  12  * mLib is free software: you can redistribute it and/or modify it under
  13  * the terms of the GNU Library General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or (at
  15  * your option) any later version.
  16  *
  17  * mLib is distributed in the hope that it will be useful, but WITHOUT
  18  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  19  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
  20  * License for more details.
  21  *
  22  * You should have received a copy of the GNU Library General Public
  23  * License along with mLib.  If not, write to the Free Software
  24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  25  * USA.
  26  */
  27
  28 #ifndef MLIB_EXAMPLE_H
  29 #define MLIB_EXAMPLE_H
  30
  31 #ifdef __cplusplus
  32   extern "C" {
  33 #endif
  34
  35 /*----- Header files ------------------------------------------------------*/
  36
  37 #include <stddef.h>
  38
  39 /*----- Functions provided ------------------------------------------------*/
  40
  41 extern int add(int /*x*/, int /*y*/);
  42   /* Return the sum X + Y. */
  43
  44 extern int greet(char */*buf*/, size_t /*sz*/, const char */*name*/);
  45   /* Generate a personalized greeting, mentioning NAME.  The greeting is
  46    * written to the output buffer BUF, which has space for SZ characters.
  47    * Return zero on success, or -1 on error.
  48    */
  49
  50 /*----- That's all, folks -------------------------------------------------*/
  51
  52 #ifdef __cplusplus
  53   }
  54 #endif
  55
  56 #endif