Cannot link properties without .index file

Bug #1202561 reported by Tim Peeters on 2013-07-18
12
This bug affects 2 people
Affects Status Importance Assigned to Milestone
Ubuntu UI Toolkit
Fix Released
Medium
Christian Dywan
Unity Action API
Medium
Christian Dywan
ubuntu-ui-toolkit (Ubuntu)
Undecided
Unassigned
unity-action-api (Ubuntu)
Undecided
Unassigned

Bug Description

When we create a new QML component that inherits properties from other components, it is not possible to add documentation for those properties. Also, if the parent component is defined outside UITK, its properties don't appear in the UITK documentation.

Examples where we need this:
- To document the "enabled" property of ActionItem
- Most of the properties of Action are defined in Ubuntu.Unity.Action, not in UITK, but we currently have no way of combining the UITK documentation with Unity.Action docs.

Related branches

Tim Peeters (tpeeters) wrote :

Perhaps Doxygen can already link to classes in another project. Quoting http://www.stack.nl/~dimitri/doxygen/manual/features.html :
"Doxygen can also automatically generate links to existing documentation that was generated with Doxygen or with Qt's non-public class browser generator. For a Qt based project this means that whenever you refer to members or classes belonging to the Qt toolkit, a link will be generated to the Qt documentation. This is done independent of where this documentation is located!"

Christian Dywan (kalikiana) wrote :

unity-action-doc needs to be updated to include a non-gzipped .index file, with which the linking works just fine in the branch.

Changed in ubuntu-ui-toolkit:
status: New → Confirmed
importance: Undecided → Medium
assignee: nobody → Christian Dywan (kalikiana)
summary: - [doc] Cannot document properties that were defined outside the file
+ Cannot link properties without .index file
Changed in unity-action-api:
assignee: nobody → Christian Dywan (kalikiana)
status: New → Confirmed
importance: Undecided → Medium
PS Jenkins bot (ps-jenkins) wrote :

Fix committed into lp:unity-action-api at revision 30, scheduled for release in unity-action-api, milestone Unknown

Changed in unity-action-api:
status: Confirmed → Fix Committed
PS Jenkins bot (ps-jenkins) wrote :

Fix committed into lp:ubuntu-ui-toolkit at revision 845, scheduled for release in ubuntu-ui-toolkit, milestone Unknown

Changed in ubuntu-ui-toolkit:
status: Confirmed → Fix Committed
Launchpad Janitor (janitor) wrote :

This bug was fixed in the package ubuntu-ui-toolkit - 0.1.46+14.04.20131126-0ubuntu1

---------------
ubuntu-ui-toolkit (0.1.46+14.04.20131126-0ubuntu1) trusty; urgency=low

  [ Loïc Molinari ]
  * [UbuntuShape] Informed renderer of index and vertex data patterns.
  * [UbuntuShape] Transformed coordinates of textures packed in atlases.
    (LP: #1252736)

  [ Jani Monoses ]
  * Avoid reference errors in OrientationHelper. (LP: #1244631)

  [ Albert Astals ]
  * Do not include the QtQml catch-all include header Include the
    headers we need instead .
  * Compile properly with make -j10 Otherwise tries to compile the tests
    before the components.so is there and fails.

  [ Christian Dywan ]
  * Only inspect left hand for keywords and omit identifier. (LP:
    #1250653)
  * Merge pot update scripts and tweak 'make pot'. (LP: #1186250)
  * Add dependencies and indexes to link Qt5 and Ubuntu.Unity.Action
    docs. (LP: #1202561)
  * Implement BUILTINS in qmlapicheck to exclude built-in types.
  * Move ubuntu-ui-toolkit-doc dep from -examples to Recommends This way
    it's possible to run autopilot tests without docs.

  [ Zsombor Egri ]
  * Tabs are controlled independently by TabBar from Tabs component.
    (LP: #1246758)

  [ Florian Boucault ]
  * Conditionally disable v8-private dependency if Qt's version >= 5.2.
  * TextArea: added missing MathUtils import. (LP: #1248731)
  * Homogenized the icon related APIs. Everywhere where an icon can be
    set 2 properties are defined: url iconSource: url of any image file
    that can be used as the icon. string iconName: name of the icon in
    the theme. Redundant APIs are now deprecated. Action, ActionItem,
    OptionSelectorDelegate, ListItems.Base and ListItems.Standard have
    been modified. (LP: #1191054)

  [ Leo Arias ]
  * Add the .py files to the qtcreator project. (LP: #1244615)
  * Added logging for all the public methods on the autopilot emulators.

  [ Robert Bruce Park ]
  * Fix indicator tabs ordering.

  [ Michael Zanetti ]
  * fix typo in ListItems.Empty doc string.

  [ tpeeters ]
  * Align ListView header with MainView header. (LP: #1202403, #1202277)
  * Support initial value of selectionMode that is not equal to false.
    (LP: #1250194)

  [ Ubuntu daily release ]
  * Automatic snapshot from revision 859
 -- Ubuntu daily release <email address hidden> Tue, 26 Nov 2013 01:11:34 +0000

Changed in ubuntu-ui-toolkit (Ubuntu):
status: New → Fix Released
Launchpad Janitor (janitor) wrote :

This bug was fixed in the package unity-action-api - 1.1.0+14.04.20140206-0ubuntu1

---------------
unity-action-api (1.1.0+14.04.20140206-0ubuntu1) trusty; urgency=medium

  [ Pete Woods ]
  * Add automatic quit action to HUD toolbar.
  * Upload to trusty

  [ Dimitri John Ledkov ]
  * Fix cross-compilation, by using correct qdoc at compile time.

  [ Christian Dywan ]
  * Don't compress files or it breaks reading the docs. (LP: #1202561)
 -- Ubuntu daily release <email address hidden> Thu, 06 Feb 2014 12:02:11 +0000

Changed in unity-action-api (Ubuntu):
status: New → Fix Released
Zoltan Balogh (bzoltan) on 2014-10-01
Changed in ubuntu-ui-toolkit:
status: Fix Committed → Fix Released
Changed in unity-action-api:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers