← Back to branch summary

~ubuntu-branches/ubuntu/hardy/newsbeuter/hardy-security

« back to all changes in this revision

Viewing changes to doc/hackers-guide.txt

  • Committer: Bazaar Package Importer
  • Author(s): Nico Golde
  • Date: 2007-05-08 18:35:46 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20070508183546-kxo88s8lrtdyz3gv
Tags: 0.4-1
* New upstream release.
* Removed dpatch dependency and patch for header inclusion,
  included upstream.
* Changed Build-Dependencies to nxml >= 0.17.2 and mrss >= 0.17.1.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/hackers-guide.txt
86
86
*class utils*: contains several static utility functions, such as a tokenizer,
87
87
the lock file code and a text converter that builds upon iconv.
88
88
 
89
 
*class view*: the class that draws the user interface. It also reads the user's
90
 
input and runs the accordings actions.
91
 
 
92
 
*class xmlpullparser*: although called xmlpullparser, it parses virtually
 
89
*class view*: the class that draws the user interface. It manages a stack of
 
90
so-called "form actions", each of which represents one dialog. The view class
 
91
delegates all received user input events to the correct form action.
 
92
 
 
93
*class formaction*: the abstract base class for all form actions. Currently, the
 
94
following formaction-derived classes exist:
 
95
- feedlist_formaction
 
96
- itemlist_formaction
 
97
- itemview_formaction
 
98
- search_formaction
 
99
- urlview_formaction
 
100
- filebrowser_formaction
 
101
- help_formaction
 
102
- selecttag_formaction
 
103
 
 
104
class xmlpullparser*: although called xmlpullparser, it parses virtually
93
105
everything that vaguely looks like XML/HTML tags, even when totally invalid, and
94
106
provides the parsing result as a continuous stream of tokens (tags and text). It
95
107
is solely used by the htmlrenderer class.
162
174
 
163
175
Some of this output doesn't make sense very much unless you know the source
164
176
code, so it's only helpful for developers.
 
177
 
 
178
Use (and extend) the unit tests
 
179
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
180
In the test subdirectory resides a simple unit test to check the most important
 
181
functionality of the newsbeuter internals. These test build upon Boost.Test which
 
182
you can grab from http://www.boost.org/ (Debian users only need to install
 
183
libboost-test-dev). Run "make test" to build the tests, the result is a binary
 
184
called "test" within the test subdirectory. Run it and see whether everything
 
185
still works as expected. Run "make clean-test" to clean up after the tests.