Improved the Doxygen sample project.
This commit is contained in:
Jussi Pakkanen
parent
d7dd20b1c1
commit
8ecff137cb
|
|
@ -32,13 +32,13 @@ DOXYFILE_ENCODING = UTF-8
|
|||
# title of most generated pages and in a few other places.
|
||||
# The default value is: My Project.
|
||||
|
||||
PROJECT_NAME = "Spede"
|
||||
PROJECT_NAME = "The Vast Comedian Project"
|
||||
|
||||
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
|
||||
# could be handy for archiving the generated documentation or if some version
|
||||
# control system is used.
|
||||
|
||||
PROJECT_NUMBER =
|
||||
PROJECT_NUMBER = @VERSION@
|
||||
|
||||
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
||||
# for a project that appears at the top of each page and should give viewer a
|
||||
|
|
|
|||
|
|
@ -0,0 +1,17 @@
|
|||
#pragma once
|
||||
|
||||
namespace Comedy {
|
||||
|
||||
/**
|
||||
* Interface for a funnyperson.
|
||||
*/
|
||||
class Comedian {
|
||||
public:
|
||||
/**
|
||||
* Do the thing people want to happen.
|
||||
*/
|
||||
virtual void tell_joke() = 0;
|
||||
virtual ~Comedian();
|
||||
};
|
||||
|
||||
}
|
||||
|
|
@ -1,11 +1,19 @@
|
|||
#pragma once
|
||||
#include<comedian.h>
|
||||
#include<stdexcept>
|
||||
|
||||
/**
|
||||
* \file spede.h
|
||||
*
|
||||
* Spede definition.
|
||||
*/
|
||||
|
||||
namespace Comedy {
|
||||
|
||||
/**
|
||||
* Spede is the funniest person in the world.
|
||||
*/
|
||||
class Spede {
|
||||
class Spede : public Comedian {
|
||||
public:
|
||||
/**
|
||||
* Creates a new spede.
|
||||
|
|
@ -16,7 +24,14 @@ namespace Comedy {
|
|||
* Make him do the funny thing he is known for.
|
||||
*/
|
||||
void slap_forehead();
|
||||
|
||||
virtual void tell_joke() {
|
||||
throw std::runtime_error("Not implemented");
|
||||
}
|
||||
|
||||
};
|
||||
|
||||
|
||||
private:
|
||||
|
||||
int num_movies; ///< How many movies has he done.
|
||||
|
|
|
|||
|
|
@ -1,13 +1,20 @@
|
|||
usr/share/doc/spede/html/annotated.html
|
||||
usr/share/doc/spede/html/arrowdown.png
|
||||
usr/share/doc/spede/html/arrowright.png
|
||||
usr/share/doc/spede/html/bc_s.png
|
||||
usr/share/doc/spede/html/bdwn.png
|
||||
usr/share/doc/spede/html/classComedy_1_1Comedian.html
|
||||
usr/share/doc/spede/html/classComedy_1_1Comedian.png
|
||||
usr/share/doc/spede/html/classComedy_1_1Comedian-members.html
|
||||
usr/share/doc/spede/html/classComedy_1_1Spede.html
|
||||
usr/share/doc/spede/html/classComedy_1_1Spede.png
|
||||
usr/share/doc/spede/html/classComedy_1_1Spede-members.html
|
||||
usr/share/doc/spede/html/classes.html
|
||||
usr/share/doc/spede/html/closed.png
|
||||
usr/share/doc/spede/html/comedian_8h_source.html
|
||||
usr/share/doc/spede/html/dir_7bdce917e28dfbd493cadd1d2e5c7d80.html
|
||||
usr/share/doc/spede/html/dir_44a4667d36a4476878de085754f6d2b9.html
|
||||
usr/share/doc/spede/html/dir_68b523c5b3a2dcea45d5ce70397fb722.html
|
||||
usr/share/doc/spede/html/dir_7bdce917e28dfbd493cadd1d2e5c7d80.html
|
||||
usr/share/doc/spede/html/dir_a7e6472d2301212032fd74682f8217f3.html
|
||||
usr/share/doc/spede/html/dir_ee191f21c02d247cc959e80c1a3acadf.html
|
||||
usr/share/doc/spede/html/doc.png
|
||||
|
|
@ -17,38 +24,60 @@ usr/share/doc/spede/html/dynsections.js
|
|||
usr/share/doc/spede/html/files.html
|
||||
usr/share/doc/spede/html/folderclosed.png
|
||||
usr/share/doc/spede/html/folderopen.png
|
||||
usr/share/doc/spede/html/functions_func.html
|
||||
usr/share/doc/spede/html/functions.html
|
||||
usr/share/doc/spede/html/functions_func.html
|
||||
usr/share/doc/spede/html/hierarchy.html
|
||||
usr/share/doc/spede/html/index.html
|
||||
usr/share/doc/spede/html/jquery.js
|
||||
usr/share/doc/spede/html/menudata.js
|
||||
usr/share/doc/spede/html/menu.js
|
||||
usr/share/doc/spede/html/namespaceComedy.html
|
||||
usr/share/doc/spede/html/namespacemembers.html
|
||||
usr/share/doc/spede/html/namespacemembers_func.html
|
||||
usr/share/doc/spede/html/namespaces.html
|
||||
usr/share/doc/spede/html/nav_f.png
|
||||
usr/share/doc/spede/html/nav_g.png
|
||||
usr/share/doc/spede/html/nav_h.png
|
||||
usr/share/doc/spede/html/open.png
|
||||
usr/share/doc/spede/html/search/all_0.html
|
||||
usr/share/doc/spede/html/search/all_0.js
|
||||
usr/share/doc/spede/html/search/all_1.html
|
||||
usr/share/doc/spede/html/search/all_1.js
|
||||
usr/share/doc/spede/html/search/all_2.html
|
||||
usr/share/doc/spede/html/search/all_2.js
|
||||
usr/share/doc/spede/html/search/all_3.html
|
||||
usr/share/doc/spede/html/search/all_3.js
|
||||
usr/share/doc/spede/html/search/classes_0.html
|
||||
usr/share/doc/spede/html/search/classes_0.js
|
||||
usr/share/doc/spede/html/search/classes_1.html
|
||||
usr/share/doc/spede/html/search/classes_1.js
|
||||
usr/share/doc/spede/html/search/close.png
|
||||
usr/share/doc/spede/html/search/files_0.html
|
||||
usr/share/doc/spede/html/search/files_0.js
|
||||
usr/share/doc/spede/html/search/functions_0.html
|
||||
usr/share/doc/spede/html/search/functions_0.js
|
||||
usr/share/doc/spede/html/search/functions_1.html
|
||||
usr/share/doc/spede/html/search/functions_1.js
|
||||
usr/share/doc/spede/html/search/functions_2.html
|
||||
usr/share/doc/spede/html/search/functions_2.js
|
||||
usr/share/doc/spede/html/search/mag_sel.png
|
||||
usr/share/doc/spede/html/search/namespaces_0.html
|
||||
usr/share/doc/spede/html/search/namespaces_0.js
|
||||
usr/share/doc/spede/html/search/nomatches.html
|
||||
usr/share/doc/spede/html/search/pages_0.html
|
||||
usr/share/doc/spede/html/search/pages_0.js
|
||||
usr/share/doc/spede/html/search/search.css
|
||||
usr/share/doc/spede/html/search/search.js
|
||||
usr/share/doc/spede/html/search/searchdata.js
|
||||
usr/share/doc/spede/html/search/search_l.png
|
||||
usr/share/doc/spede/html/search/search_m.png
|
||||
usr/share/doc/spede/html/search/search_r.png
|
||||
usr/share/doc/spede/html/spede_8cpp.html
|
||||
usr/share/doc/spede/html/spede_8h.html
|
||||
usr/share/doc/spede/html/spede_8h_source.html
|
||||
usr/share/doc/spede/html/splitbar.png
|
||||
usr/share/doc/spede/html/sync_off.png
|
||||
usr/share/doc/spede/html/sync_on.png
|
||||
usr/share/doc/spede/html/tabs.css
|
||||
usr/share/doc/spede/html/tab_a.png
|
||||
usr/share/doc/spede/html/tab_b.png
|
||||
usr/share/doc/spede/html/tab_h.png
|
||||
usr/share/doc/spede/html/tabs.css
|
||||
usr/share/doc/spede/html/tab_s.png
|
||||
|
||||
usr/share/doc/spede/html/search/all_0.html
|
||||
usr/share/doc/spede/html/search/all_0.js
|
||||
usr/share/doc/spede/html/search/classes_0.html
|
||||
usr/share/doc/spede/html/search/classes_0.js
|
||||
usr/share/doc/spede/html/search/close.png
|
||||
usr/share/doc/spede/html/search/functions_0.html
|
||||
usr/share/doc/spede/html/search/functions_0.js
|
||||
usr/share/doc/spede/html/search/mag_sel.png
|
||||
usr/share/doc/spede/html/search/nomatches.html
|
||||
usr/share/doc/spede/html/search/search.css
|
||||
usr/share/doc/spede/html/search/searchdata.js
|
||||
usr/share/doc/spede/html/search/search.js
|
||||
usr/share/doc/spede/html/search/search_l.png
|
||||
usr/share/doc/spede/html/search/search_m.png
|
||||
usr/share/doc/spede/html/search/search_r.png
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
project('doxygen test', 'cpp')
|
||||
project('doxygen test', 'cpp', version : '0.1.0')
|
||||
|
||||
doxygen = find_program('doxygen', required : false)
|
||||
if not doxygen.found()
|
||||
|
|
@ -6,6 +6,7 @@ if not doxygen.found()
|
|||
endif
|
||||
|
||||
cdata = configuration_data()
|
||||
cdata.set('VERSION', meson.project_version())
|
||||
|
||||
if find_program('dot', required : false).found()
|
||||
cdata.set('HAVE_DOT', 'YES')
|
||||
|
|
|
|||
|
|
@ -1,5 +1,30 @@
|
|||
#include<spede.h>
|
||||
|
||||
/**
|
||||
* \file spede.cpp
|
||||
*
|
||||
* This file contains the implementation of the king of comedy.
|
||||
*/
|
||||
|
||||
/**
|
||||
* \mainpage The Vast Comedian Project
|
||||
*
|
||||
* \section intro Introduction
|
||||
*
|
||||
* The purpose of this project is to model every single comedian
|
||||
* who has ever lived.
|
||||
*
|
||||
* \section sched Project schedule
|
||||
*
|
||||
* There is no real estimate on when this will be finished.
|
||||
*/
|
||||
|
||||
/**
|
||||
* \namespace Comedy
|
||||
*
|
||||
* This contains everything that is funny.
|
||||
*/
|
||||
|
||||
namespace Comedy {
|
||||
|
||||
/**
|
||||
|
|
|
|||
Loading…
Reference in New Issue