0ct0pu5/wesnoth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add a design note to src/help/help_impl.?pp

Browse source
This commit is contained in:
Chris Beck 2014-11-21 15:43:48 -05:00
parent da45d19799
commit 51a8ae88df
1 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
src/help/help_impl.hpp
View file

@ -12,6 +12,23 @@
See the COPYING file for more details.
*/
/**
* Note:
* Prior to the creation of this file, all the code associated to the help
* browser existed in a single file src/help.cpp, including all of the
* widgets, topic generators, and implementation details. This totaled
* ~4000 lines of code.
*
* I have split it all up now, so that the gui aspects are separated from
* the content, the "front facing" part which the rest of the code base
* interacts with is in src/help/help.?pp, and the topic generators are
* separated. The remaining "guts" are here. It is implemented in a static
* singleton pattern, using "extern"'d variables, simply for ease of translation
* from the previous state. It would probably be a good idea to rewrite this
* guy as a proper C++ object. Feel free to do so, or to adopt some other
* design pattern.
*/
#ifndef HELP_IMPL_INCLUDED
#define HELP_IMPL_INCLUDED