summaryrefslogtreecommitdiff
path: root/app/tools/HACKING
diff options
context:
space:
mode:
Diffstat (limited to 'app/tools/HACKING')
-rw-r--r--app/tools/HACKING35
1 files changed, 35 insertions, 0 deletions
diff --git a/app/tools/HACKING b/app/tools/HACKING
new file mode 100644
index 0000000..779bf58
--- /dev/null
+++ b/app/tools/HACKING
@@ -0,0 +1,35 @@
+/** \file filename.c
+ * This file shows the conventions used for inline documentation.
+ *
+ * $Header: /home/dmarkle/xtrkcad-fork-cvs/xtrkcad/app/tools/HACKING,v 1.3 2007-11-13 19:31:12 m_fischer Exp $
+ */
+
+/* XTrkCad - 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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
+ */
+