packagesearch-2.7.4/ 0000755 0000000 0000000 00000000000 12233535632 011177 5 ustar packagesearch-2.7.4/doc/ 0000755 0000000 0000000 00000000000 12233535631 011743 5 ustar packagesearch-2.7.4/doc/programming-guidelines.html 0000644 0000000 0000000 00000014462 11711275554 017315 0 ustar
Main Identifier: Plugin Name
Additional Information:
Author
Version
Location (Path, derived from library location)
Implicit search path order: plugins/, ../plugins/, /usr/lib/packagesearch
If more than one version is available use the one appearing first in the search path
Plugin file names must be of the format: lib<pluginname>.so
// this is OK
func(aVeryLongVariableName1, aMuchMoreLongerVariableNameWhichFillsAllTheLine2,
aVeryLongVariableNameWhichIsReallyLong3, aVeryLongVariableNameWhichIsReallyLong4);
// if more than this:
func (
aVeryLongVariableNameWhichIsReallyLong1, aMuchMuchLongerVariableName2
aVeryLongVariableNameWhichIsReallyLong3, aMuchMuchLongerVariableName4
aVeryLongVariableNameWhichIsReallyLong5, aMuchMuchLongerVariableName5
);
/** @brief This holds the package collection ready to be used.
*
* Use the output function for your consumers
*/
If they need only one line the closing */ must be
on the same line:
/** This manages the include widgets (but not the labels belonging to them. */
#include <...> proceeds
#include "..."
include order:
- stl includes
- opengl includes
- qt includes
- other global includes (those with <>)
- the corresponding header for the cpp file
("xmldata.h" for xmldata.cpp)
- other local includes
Grouping:
- local includes from the same namespace are
grouped together (followed by an
empty line
- includes from the same external library or
directory are grouped together
Saving happens in XML
Error handling:
- if something wasn't loaded
properly we will try to set a reasonable default value
- We will not go to the next
entry if loading of an element failed, so if there is a
broken tag (e.g. wrong
spelling) this will break all following parts. This is done
because if we added a new
item in the DTD and we have an incorrect XML file where
this entry is missing, it
will use a default value and the next tag will read the
correct entry.
Saving in packagesearch:
- comments in the configuration
file are not allowed