summaryrefslogtreecommitdiffstats
path: root/examples/tictac/tictac.doc
diff options
context:
space:
mode:
Diffstat (limited to 'examples/tictac/tictac.doc')
-rw-r--r--examples/tictac/tictac.doc33
1 files changed, 33 insertions, 0 deletions
diff --git a/examples/tictac/tictac.doc b/examples/tictac/tictac.doc
new file mode 100644
index 0000000..05b16fb
--- /dev/null
+++ b/examples/tictac/tictac.doc
@@ -0,0 +1,33 @@
+/*
+*/
+/*! \page tictac-example.html
+
+ \ingroup examples
+ \title Tic Tac Toe
+
+ This is an implementation of the Tic-tac-toe game.
+
+ We didn't put much effort in making a clever algorithm so it's not a
+ challenge to play against the computer. Instead, study the source code
+ to see how you can make reusable components such as the \e TicTacGameBoard
+ widget.
+
+ <hr>
+
+ Header file:
+
+ \include tictac/tictac.h
+
+ <hr>
+
+ Implementation:
+
+ \include tictac/tictac.cpp
+
+ <hr>
+
+ Main:
+
+ \include tictac/main.cpp
+*/
+