kapidox::models::Library

Search for usage in LXR

kapidox.models.Library Class Reference

Inherits object.

Public Member Functions

def __init__ (self, metainfo, products, platforms, all_maintainers)
 

Public Attributes

 cmakename
 
 dependency_diagram
 
 deprecated
 
 description
 
 docdir
 
 exampledirs
 
 fancyname
 
 href
 
 irc
 
 libraries
 
 mailinglist
 
 maintainers
 
 metainfo
 
 name
 
 outputdir
 
 parent
 
 part_of_group
 
 path
 
 platforms
 
 portingAid
 
 product
 
 repopath
 
 srcdirs
 
 subproduct
 
 type
 

Detailed Description

Library.

Definition at line 19 of file models.py.

Constructor & Destructor Documentation

def kapidox.models.Library.__init__ (   self,
  metainfo,
  products,
  platforms,
  all_maintainers 
)

Constructor of the Library object.

Parameters
metainfo(dict) dictionary describing a library
products(list of Products) list of all already created products
platforms(dict) dictionary of all platforms for which the library is available, where the key is a platform and the value is a restriction. For instance:
1 {
2  'Linux': '',
3  'Windows': 'Tested with Windows 10 only'
4 }
would work.
all_maintainers(dict of dict) all possible maintainers, where the main key is a username/unique pseudo, and the key is a dictionary of name, email address. For example:
1 {
2  'username01': { 'name': 'Paul Developer', 'email': '[email protected]' },
3  'username02': { 'name': 'Marc Developer2', 'email': '[email protected]' }
4 }
would work.

Definition at line 49 of file models.py.


The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Sat Oct 16 2021 22:55:44 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.