Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Objective-C protocol @optional/@required not represented in XML (Origin: bugzilla #591749) #3477

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Copy link
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity minor in component general for ---
Reported in version 1.5.9 on platform Other
Assigned to: Dimitri van Heesch

On 2009-08-13 21:53:02 +0000, Matt Ball wrote:

Please describe the problem:
Doxygen does not appear to add any information about whether Objective-C 2.0 protocol methods have been marked as @optional or @required to its XML output.

This information is added to the generated HTML files, but there does not seem to be any way to determine whether a protocol method is optional or required solely from the XML output. This makes it very difficult to write XSLT stylesheets to format the XML however one wants -- no matter what, the information available from the XML is not as complete as that in the HTML output.

Steps to reproduce:

  1. Mark protocol methods as @optional or @required
  2. Generate XML documentation
  3. Look for any indicators as to required-ness in the generated XML

Actual results:
There is no way to determine whether a given member of the protocol is optional or required.

Expected results:
Each member has a "required='yes/no'" attribute or something similar.

Does this happen every time?
yes

Other information:
I maintain a script (called Doxyclean) which converts Doxygen's XML output into a format which is consistent with Apple's documentation. Without this information, my script is unable to mark protocol methods appropriately.

On 2009-08-14 07:30:46 +0000, Dimitri van Heesch wrote:

Hi Matt,

I'll add the missing attributes in the next update, along with the missing set accessor for properties (assign|retain|copy).

I'll also add a link to your script from the helpers section of doxygen's website so more people can find it.

On 2009-08-20 10:13:17 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.6.0. Please verify if this is indeed the case and reopen the
bug if you think it is not fixed (include any additional information that you
think can be relevant).

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.