/** \file filename.c * This file shows the conventions used for inline documentation. */ /* XTrackCAD - Model Railroad CAD * Copyright (C) * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ int global; /**< this is a global variable */ /** * Brief description of function. And some more words about * this function bla bla bla * * \param varname1 IN this is a variable * \param varname2 OUT and another one that is modified * \return describe the return value */