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

Doxygen sometimes mangles the method in the @see section (Origin: bugzilla #636475) #4036

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

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity normal in component build for ---
Reported in version 1.7.2 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2010-12-04 19:03:45 +0000, Tito Ciuro wrote:

Created attachment 175846
Project sources + Doxyfile

Sometimes, Doxygen mangles the method located in a @see section. For example:

/** * Removes an object from the document store.

  • @param theObject the object to be removed from the document store.
  • @param outError is used if an error occurs. May be NULL.
  • @return YES upon success, NO otherwise.
  • @warning The objects of the array must be NSFNanoObjectProtocol-compliant.
  • @see - (BOOL)removeObjectsWithKeysInArray:(NSArray *)theKeys error:(out NSError **)outError;
  • @see - (BOOL)removeObjectsInArray:(NSArray *)theObjects error:(out NSError **)outError;
  • @see - (BOOL)removeAllObjectsFromStoreAndReturnError:(out NSError **)outError;
  • @see
    */
  • (BOOL)removeObject:(id )theObject error:(out NSError **)outError;

Displays the following (I only show the @see section):

See also:

  • (BOOL)removeObjectsWithKeysInArray:(NSArray *)theKeys error:(out NSError **)outError;
  • (BOOL)removeObjectsInArray:(NSArray *)theObjects error:(out NSError **)outError;
  • (BOOL)- removeAllObjectsFromStoreAndReturnError:outError;

As you can see, the last method is wrong (should not contain a "-" before removeAllObjectsFromStoreAndReturnError:outError).

Instructions:

  • unzip the attachment
  • cd into Classes/Public
  • open NSFNanoStore.h

Locate the method: - (BOOL)removeObject:(id )theObject error:(out NSError **)outError;

I have attached the sources + Doxyfile

On 2011-01-02 10:51:28 +0000, Dimitri van Heesch wrote:

When refering to other Objective-C methods you should use:

@see removeObjectsWithKeysInArray:error:

This is also the convention used by Apple and doxygen will autolink to the method and add the - or +.

If you want to refer to the full prototype you should use \ref

@see \ref removeObjectsWithKeysInArray:error: "-(BOOL) remogeObjectsWithKeysInArray:(NSArray*) theKeys error:(out NSError **) outError"

or

@see \link removeObjectsInArray:error: - (BOOL)removeAllObjectsFromStoreAndReturnError:(out NSError **)outError;\endlink

Using \ref does not work at the moment, but I will correct this in the next subversion update.

On 2011-01-03 19:01:31 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.3. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please 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