Update API documentation and dot files.
This commit is contained in:
parent
4e0c933c7f
commit
192ffa2d58
@ -5,7 +5,7 @@
|
||||
DOXYF ?= xbps_api_doxyfile
|
||||
FORMAT ?= png
|
||||
FILES = xbps_transaction_dictionary.$(FORMAT)
|
||||
FILES += xbps_pkgdb_array.$(FORMAT)
|
||||
FILES += xbps_pkgdb_dictionary.$(FORMAT)
|
||||
FILES += xbps_pkg_props_dictionary.$(FORMAT)
|
||||
FILES += xbps_pkg_files_dictionary.$(FORMAT)
|
||||
FILES += xbps_binary_pkg_content.$(FORMAT)
|
||||
|
@ -334,22 +334,6 @@ INLINE_SIMPLE_STRUCTS = NO
|
||||
|
||||
TYPEDEF_HIDES_STRUCT = YES
|
||||
|
||||
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
|
||||
# determine which symbols to keep in memory and which to flush to disk.
|
||||
# When the cache is full, less often used symbols will be written to disk.
|
||||
# For small to medium size projects (<1000 input files) the default value is
|
||||
# probably good enough. For larger projects a too small cache size can cause
|
||||
# doxygen to be busy swapping symbols to and from disk most of the time
|
||||
# causing a significant performance penalty.
|
||||
# If the system has enough physical memory increasing the cache will improve the
|
||||
# performance by keeping more symbols in memory. Note that the value works on
|
||||
# a logarithmic scale so increasing the size by one will roughly double the
|
||||
# memory usage. The cache size is given by this formula:
|
||||
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
|
||||
# corresponding to a cache size of 2^16 = 65536 symbols.
|
||||
|
||||
SYMBOL_CACHE_SIZE = 0
|
||||
|
||||
# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
|
||||
# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
|
||||
# their name and scope. Since this can be an expensive process and often the
|
||||
@ -1231,7 +1215,7 @@ MATHJAX_EXTENSIONS =
|
||||
# typically be disabled. For large projects the javascript based search engine
|
||||
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
|
||||
|
||||
SEARCHENGINE = YES
|
||||
#SEARCHENGINE = YES
|
||||
|
||||
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
|
||||
# implemented using a PHP enabled web server instead of at the web client
|
||||
|
@ -1,10 +1,10 @@
|
||||
digraph pkgdb_array {
|
||||
digraph pkgdb_dictionary {
|
||||
graph [rankdir=LR,rank=same,ranksep=".10"];
|
||||
edge [arrowhead="vee",arrowsize="0.2",fontname="DejaVuSansCondensed",fontsize="9"];
|
||||
node [height=".1",shape=box,fontname="DejaVuSansCondensed",fontsize="9"];
|
||||
pkgdb_plist -> main;
|
||||
pkgdb_plist [style=filled,fillcolor="darksalmon",label="pkgdb.plist"];
|
||||
main [label="Main array"];
|
||||
pkgdb_plist [style=filled,fillcolor="darksalmon",label="pkgdb-0.21.plist"];
|
||||
main [label="Main dictionary"];
|
||||
main -> pkgdict [label="dictionary"];
|
||||
main -> pkgdict2 [label="dictionary"];
|
||||
pkgdict [style=filled,label="Package[0]"];
|
@ -45,10 +45,10 @@
|
||||
* dictionary (the array returned by xbps_find_pkg_orphans() will
|
||||
* contain a package dictionary per orphan found):
|
||||
*
|
||||
* @image html images/xbps_pkgdb_array.png
|
||||
* @image html images/xbps_pkgdb_dictionary.png
|
||||
*
|
||||
* Legend:
|
||||
* - <b>Salmon filled box</b>: \a XBPS_REGPKGDB_PLIST file internalized.
|
||||
* - <b>Salmon filled box</b>: \a pkgdb plist internalized.
|
||||
* - <b>White filled box</b>: mandatory objects.
|
||||
* - <b>Grey filled box</b>: optional objects.
|
||||
* - <b>Green filled box</b>: possible value set in the object, only one
|
||||
|
@ -41,10 +41,10 @@
|
||||
* The following image shown below shows the proplib structure used
|
||||
* by the main package database plist:
|
||||
*
|
||||
* @image html images/xbps_pkgdb_array.png
|
||||
* @image html images/xbps_pkgdb_dictionary.png
|
||||
*
|
||||
* Legend:
|
||||
* - <b>Salmon filled box</b>: \a XBPS_PKGDB file internalized.
|
||||
* - <b>Salmon filled box</b>: \a pkgdb plist internalized.
|
||||
* - <b>White filled box</b>: mandatory objects.
|
||||
* - <b>Grey filled box</b>: optional objects.
|
||||
* - <b>Green filled box</b>: possible value set in the object, only one
|
||||
|
Loading…
Reference in New Issue
Block a user