languages/cpp/doxydoc.h
Go to the documentation of this file.00001 /*************************************************************************** 00002 * Copyright (C) 2003 by Jonas B. Jacobi * 00003 * j.jacobi@gmx.de * 00004 * * 00005 * This program is free software; you can redistribute it and/or modify * 00006 * it under the terms of the GNU General Public License as published by * 00007 * the Free Software Foundation; either version 2 of the License, or * 00008 * (at your option) any later version. * 00009 ***************************************************************************/ 00010 #ifndef DOXYDOC_H 00011 #define DOXYDOC_H 00012 00013 #include <qstring.h> 00014 #include <qdom.h> 00015 #include <qdir.h> 00016 #include <qfile.h> 00017 #include <list> 00018 00024 class DoxyDoc 00025 { 00026 public: 00031 DoxyDoc(const QStringList& dir); 00032 ~DoxyDoc(){}; 00040 QString functionDescription(const QString& scope, const QString& name, const QString& type, const QString& arguments); 00041 /*not implemented yet, maybe later, if they are useful 00042 QString classDescription(); 00043 QString enumDescription(); 00044 QString namespaceDescription(); 00045 QString memberVarDescription(); 00046 */ 00047 private: 00048 static void formatType(QString& type); 00049 std::list<QDir> m_dirs; 00050 //used for temporary storing/performance reasons 00051 QFile m_file; 00052 QDomNodeList m_list; 00053 }; 00054 00055 #endif