{ "info": { "author": "Aur\u00e9lien G\u00e2teau", "author_email": "mail@agateau.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Plugins", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Topic :: Documentation" ], "description": "[![Build Status](https://travis-ci.org/agateau/doxyqml.svg?branch=master)](https://travis-ci.org/agateau/doxyqml)\n[![Coverage Status](https://coveralls.io/repos/github/agateau/doxyqml/badge.svg?branch=master)](https://coveralls.io/github/agateau/doxyqml?branch=master)\n\n# Goals\n\nDoxyqml lets you use Doxygen to document your QML classes.\n\nIt integrates as a Doxygen input filter to turn .qml files into pseudo-C++\nwhich Doxygen can then use to generate documentation.\n\n# Installing\n\nDoxyqml uses the standard Python setup tools, so you can install it with pip:\n\n pip3 install doxyqml\n\nor manually with:\n\n python3 setup.py install\n\n# Telling Doxygen to use Doxyqml\n\nTo tell Doxygen about Doxyqml you must make a few changes to your Doxygen\nconfiguration file.\n\n1. Add the .qml extension to the `FILTER_PATTERNS` key:\n\n FILTER_PATTERNS = *.qml=doxyqml\n\n Note: on Windows Doxyqml installs itself in the `Scripts` folder of your\n Python installation. If this folder is not in the PATH, either add it or use\n the full path to Doxyqml here (but that is less portable across machines)\n\n2. Add the .qml extension to `FILE_PATTERNS`:\n\n FILE_PATTERNS = *.qml\n\n3. Since Doxygen 1.8.8, you must also add the .qml extension to\n `EXTENSION_MAPPING`:\n\n EXTENSION_MAPPING = qml=C++\n\n# Documenting types\n\nQML is partially-typed: functions are untyped, properties and signals are.\nDoxyqml provides a way to define types when they are missing or not precise\nenough.\n\n## Functions\n\nFunctions in QML are untyped, but you can define types in the documentation\nlike this:\n\n /**\n * Create a user\n * @param type:string firstname User firstname\n * @param type:string lastname User lastname\n * @param type:int User age\n * @return type:User The User object\n */\n function createUser(firstname, lastname, age);\n\n## Properties\n\nQML properties are typed, so Doxyqml uses them by default. You can nevertheless\noverwrite the type using the same `type:` syntax. This is useful to\ndocument property aliases:\n\n /** type:string The user lastname */\n property alias lastname: someObject.text\n\n## Signals\n\nQML signals are typed, so there is no need to use the `type:` syntax to\ndocument their parameters. Using `type:` syntax in signal documentation\nwill not work: Doxyqml won't strip it out and Doxygen will confuse it with the\nparameter name.\n\n /**\n * User just logged in\n * @param user The user which logged in\n */\n signal loggedIn(User user)\n\n## Extracting internal elements\n\nQML elements with an id are exported as private member variables. If you set\nthe `EXTRACT_ALL` and EXTRACT_PRIVATE` Doxygen keys to `YES`, then these\nelements will be visible in the generated documentation.", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://agateau.com/projects/doxyqml", "keywords": "", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "doxyqml", "package_url": "https://pypi.org/project/doxyqml/", "platform": "any", "project_url": "https://pypi.org/project/doxyqml/", "project_urls": { "Homepage": "http://agateau.com/projects/doxyqml" }, "release_url": "https://pypi.org/project/doxyqml/0.5.0/", "requires_dist": null, "requires_python": "", "summary": "Doxygen input filter for QML files", "version": "0.5.0" }, "last_serial": 4550419, "releases": { "0.1.0": [], "0.2.0": [ { "comment_text": "", "digests": { "md5": "4e21473932f29e14970fc07d17b75207", "sha256": "aea4d26a48031967d9f3fe76b9c1868d1f2cc0698b283de54eadd6b353815099" }, "downloads": -1, "filename": "doxyqml-0.2.0.tar.bz2", "has_sig": false, "md5_digest": "4e21473932f29e14970fc07d17b75207", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9505, "upload_time": "2014-02-11T13:33:07", "url": "https://files.pythonhosted.org/packages/ca/bd/c3546621854fe9abf2ecf2b782f5eebf35b40dc85053e570314900df026d/doxyqml-0.2.0.tar.bz2" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "d1e788d4e0d434ec5864ab29743064a6", "sha256": "b5b8fd023a07f13c868c152e4dc851fe7478daa163eb3b9230fc4a9e4146fa50" }, "downloads": -1, "filename": "doxyqml-0.3.0.tar.bz2", "has_sig": false, "md5_digest": "d1e788d4e0d434ec5864ab29743064a6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11384, "upload_time": "2016-06-20T07:23:11", "url": "https://files.pythonhosted.org/packages/36/22/9e93c2b9faeeea8113060b9eada17e0896ddd818836002482d64db8adf98/doxyqml-0.3.0.tar.bz2" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "ab978e57f7f4858589da858d4c7be1a8", "sha256": "7cc78c32c7afa89d3263b8249e6617d91a29e4cc34790701b31413c51982e90b" }, "downloads": -1, "filename": "doxyqml-0.4.0.tar.bz2", "has_sig": false, "md5_digest": "ab978e57f7f4858589da858d4c7be1a8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12765, "upload_time": "2018-05-19T17:20:47", "url": "https://files.pythonhosted.org/packages/33/0f/67c927552a1fe76fdff9eae080b7512f76651f74081871a6f326b19dc616/doxyqml-0.4.0.tar.bz2" } ], "0.5.0": [ { "comment_text": "", "digests": { "md5": "891ac5824df626ec60f9323fef9bf197", "sha256": "cfe9b8df55e71ca5effefcbb9ce54ddec371c02566bdc5e7e3a6e63e051552d3" }, "downloads": -1, "filename": "doxyqml-0.5.0.tar.bz2", "has_sig": false, "md5_digest": "891ac5824df626ec60f9323fef9bf197", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16873, "upload_time": "2018-12-01T14:49:35", "url": "https://files.pythonhosted.org/packages/9a/98/08fb1175aaae03326fd5464e4e54f1c85c978eeb22218be647a2c554b36f/doxyqml-0.5.0.tar.bz2" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "891ac5824df626ec60f9323fef9bf197", "sha256": "cfe9b8df55e71ca5effefcbb9ce54ddec371c02566bdc5e7e3a6e63e051552d3" }, "downloads": -1, "filename": "doxyqml-0.5.0.tar.bz2", "has_sig": false, "md5_digest": "891ac5824df626ec60f9323fef9bf197", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16873, "upload_time": "2018-12-01T14:49:35", "url": "https://files.pythonhosted.org/packages/9a/98/08fb1175aaae03326fd5464e4e54f1c85c978eeb22218be647a2c554b36f/doxyqml-0.5.0.tar.bz2" } ] }