summaryrefslogtreecommitdiff
path: root/client/docgen/doc.h
diff options
context:
space:
mode:
Diffstat (limited to 'client/docgen/doc.h')
-rw-r--r--client/docgen/doc.h67
1 files changed, 67 insertions, 0 deletions
diff --git a/client/docgen/doc.h b/client/docgen/doc.h
new file mode 100644
index 0000000..fc400fc
--- /dev/null
+++ b/client/docgen/doc.h
@@ -0,0 +1,67 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set et sw=2 ts=2: */
+/***************************************************************************
+ * doc.h
+ *
+ * Thu Mar 24 12:07:27 CET 2011
+ * Copyright 2011 Bent Bisballe Nyeng
+ * deva@aasimon.org
+ ****************************************************************************/
+
+/*
+ * This file is part of Pracro.
+ *
+ * Pracro 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.
+ *
+ * Pracro 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 Pracro; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+ */
+#ifndef __PRACRO_DOC_H__
+#define __PRACRO_DOC_H__
+
+#include <QVector>
+#include <QString>
+
+class Parameter {
+public:
+ QString name;
+ QString description;
+};
+
+class Method {
+public:
+ QString name;
+ QString description;
+ QString returns;
+ QVector<Parameter> parameters;
+};
+
+class Attribute {
+public:
+ QString name;
+ QString description;
+};
+
+class Doc {
+public:
+ QString title;
+ QString name;
+ QString tag;
+ QString extends;
+ bool screenshot;
+ bool container;
+ QString description;
+ QVector<Attribute> attributes;
+ QVector<Method> methods;
+};
+
+#endif/*__PRACRO_DOC_H__*/