Hello community, here is the log from the commit of package kapidox for openSUSE:Factory checked in at 2018-10-02 19:45:26 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Comparing /work/SRC/openSUSE:Factory/kapidox (Old) and /work/SRC/openSUSE:Factory/.kapidox.new (New) ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Package is "kapidox" Tue Oct 2 19:45:26 2018 rev:56 rq:635974 version:5.50.0 Changes: -------- --- /work/SRC/openSUSE:Factory/kapidox/kapidox.changes 2018-08-27 12:57:54.236721458 +0200 +++ /work/SRC/openSUSE:Factory/.kapidox.new/kapidox.changes 2018-10-02 19:45:29.157950303 +0200 @@ -1,0 +2,11 @@ +Thu Sep 13 21:58:44 UTC 2018 - lbeltr...@kde.org + +- Update to 5.50.0 + * New feature release + * For more details please see: + * https://www.kde.org/announcements/kde-frameworks-5.50.0.php +- Changes since 5.49.0: + * Fix 2 unused vars + * enhance documentation for model classes + +------------------------------------------------------------------- Old: ---- kapidox-5.49.0.tar.xz New: ---- kapidox-5.50.0.tar.xz ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Other differences: ------------------ ++++++ kapidox.spec ++++++ --- /var/tmp/diff_new_pack.eHJuRO/_old 2018-10-02 19:45:29.769949676 +0200 +++ /var/tmp/diff_new_pack.eHJuRO/_new 2018-10-02 19:45:29.777949668 +0200 @@ -16,13 +16,13 @@ # -%define _tar_path 5.49 +%define _tar_path 5.50 # Full KF5 version (e.g. 5.33.0) %{!?_kf5_version: %global _kf5_version %{version}} # Last major and minor KF5 version (e.g. 5.33) %{!?_kf5_bugfix_version: %define _kf5_bugfix_version %(echo %{_kf5_version} | awk -F. '{print $1"."$2}')} Name: kapidox -Version: 5.49.0 +Version: 5.50.0 Release: 0 Summary: Scripts and data for building API documentation License: BSD-2-Clause ++++++ kapidox-5.49.0.tar.xz -> kapidox-5.50.0.tar.xz ++++++ diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kapidox-5.49.0/setup.py new/kapidox-5.50.0/setup.py --- old/kapidox-5.49.0/setup.py 2018-08-04 10:37:12.000000000 +0200 +++ new/kapidox-5.50.0/setup.py 2018-08-21 15:55:09.000000000 +0200 @@ -6,7 +6,7 @@ setup( name='kapidox', - version='5.49.0', + version='5.50.0', description='KDE API documentation generation tools', maintainer = 'Olivier Churlaud', maintainer_email = 'oliv...@churlaud.com', diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kapidox-5.49.0/src/kapidox/generator.py new/kapidox-5.50.0/src/kapidox/generator.py --- old/kapidox-5.49.0/src/kapidox/generator.py 2018-08-04 10:37:12.000000000 +0200 +++ new/kapidox-5.50.0/src/kapidox/generator.py 2018-08-21 15:55:09.000000000 +0200 @@ -219,7 +219,7 @@ content = codecs.open(path, encoding='utf-8', errors='ignore').read() try: return jinja2.Template(content) - except jinja2.exceptions.TemplateSyntaxError as exc: + except jinja2.exceptions.TemplateSyntaxError: logging.error('Failed to parse template {}'.format(path)) raise @@ -855,7 +855,7 @@ tag_keywords = "keywords" tag_toc = "toc" for product in products: - tree_out = ET.ElementTree(ET.Element("QtHelpProject")) + tree_out = ET.ElementTree(ET.Element(tag_root)) root_out = tree_out.getroot() root_out.set("version", "1.0") namespace = ET.SubElement(root_out, "namespace") diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kapidox-5.49.0/src/kapidox/models.py new/kapidox-5.50.0/src/kapidox/models.py --- old/kapidox-5.49.0/src/kapidox/models.py 2018-08-04 10:37:12.000000000 +0200 +++ new/kapidox-5.50.0/src/kapidox/models.py 2018-08-21 15:55:09.000000000 +0200 @@ -36,9 +36,33 @@ class Library(object): """ Library """ + def __init__(self, metainfo, products, platforms, all_maintainers): - - self.product = None + """ + Constructor of the Library object + + Args: + metainfo: (dict) dictonary describing a library + products: (list of Products) list of all already created products + platforms: (dict) dictionarry of all plaforms for which the library + is available, where the key is a platform and the value + is a restriction. For instance: + { + 'Linux': '', + 'Windows': 'Tested with Windows 10 only' + } + 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: + { + 'username01': { 'name': 'Paul Developer', 'email': 'm...@example.com' }, + 'username02': { 'name': 'Marc Developer2', 'email': 'ma...@example.com' } + } + would work. + + """ + self.product = None self.subproduct = None if 'group' in metainfo: @@ -111,12 +135,29 @@ class Product(object): """ Product """ - parent = None - # if there is a group, the product is the group - # else the product is directly the library # TODO: If no name and no group, it will fail ! def __init__(self, metainfo, all_maintainers): + """ + Constructor of the Product object + + Args: + metainfo: (dict) dictonary describing a product + 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: + { + 'username01': { 'name': 'Paul Developer', 'email': 'm...@example.com' }, + 'username02': { 'name': 'Marc Developer2', 'email': 'ma...@example.com' } + } + would work. + + """ + + self.parent = None + # if there is a group, the product is the group + # else the product is directly the library + if 'group_info' in metainfo: self.name = utils.serialize_name(metainfo['group_info'].get('name', metainfo.get('group'))) self.fancyname = metainfo['group_info'].get('fancyname', string.capwords(self.name)) @@ -186,11 +227,24 @@ class Subproduct(object): """ Subproduct """ - def __init__(self, sginfo, product): - self.fancyname = sginfo['name'] - self.name = utils.serialize_name(sginfo['name']) - self.description = sginfo.get('description') - self.order = sginfo.get('order', 99) # If no order, go to end + def __init__(self, spinfo, product): + """ + Constructor of the Subproduct object + + Args: + spinfo: (dict) description of the subproduct. It is not more than: + { + 'name': 'Subproduct Name', + 'description': 'This subproduct does this and that', + 'order': 3, # this is optional + } + for example. + product: (Product) the product it is part of. + """ + self.fancyname = spinfo['name'] + self.name = utils.serialize_name(spinfo['name']) + self.description = spinfo.get('description') + self.order = spinfo.get('order', 99) # If no order, go to end self.libraries = [] self.product = product self.parent = product