Skip to content
This repository

Feb 13, 2014

  1. Robbert Klarenbeek

    Fix handling of links containing underscores

    authored February 13, 2014

Sep 29, 2013

  1. Chuck Houpt

    Correct handling of warnOnMissingMethodArgument to suppress missing, …

    …rather then unknown warning.
    authored September 29, 2013

Jul 26, 2013

  1. working NS_ENUM

    authored July 26, 2013

Jul 25, 2013

  1. Added support for documenting typedef enums. First draft seems to work

    authored July 25, 2013

Jul 16, 2013

  1. tomaz

    Merge pull request #370 from paulmelnikow/refactor

    GBCommentsProcessor: Minor changes
    authored July 16, 2013

Jul 13, 2013

  1. Paul Melnikow

    GBCommentsProcessor: Change NULL to nil since GBCrossRefData is now a…

    …n object
    authored July 13, 2013
  2. Paul Melnikow

    GBCommentsProcessor: Refactor -[GBCrossRefData matchesObject] for rea…

    …dability
    authored July 13, 2013
  3. Paul Melnikow

    GBCommentsProcessor: Refactor handling of URLs inside method calls

    This provides much simpler handling of the change in 3485e41
    authored July 13, 2013

Jul 04, 2013

  1. Paul Melnikow

    GBCommentsProcessor: Convert GBCrossRefData to an object

    This is with an eye toward converting to ARC, which does not like having NSObjects in structs, and also makes the code more readable.
    authored July 04, 2013

Jun 16, 2013

  1. Paul Melnikow

    Fix array bounds crash in -processAvailabilityBlockInString

    Fixes #349 and failing test case:
    ```
    GBCommentsProcessorRegistrationsTesting
    testProcessCommentWithContextStore_combinations_shouldRegisterMethodDescriptionBlock
    ```
    authored June 15, 2013

Jun 15, 2013

  1. Paul Melnikow

    Fix link content duplication when links are embedded inside other links

    When a link falls within another link, such as a URL string within a method call, processing both would result in the processed URL being appended to the processed method call, duplicating the text from the URL. Instead, keep track of the links processed, and ignore a link if it's inside of a previously processed link.
    
    Here's a test case which illustrates the problem:
    
    ```objc
    /**
    `NSURL *baseURL = [NSURL URLWithString:@"http://example.com/v1/"]`
    */
    @interface Fooclass : NSObject
    @end
    ```
    
    Result:
    
    ```html
    <p><code>NSURL *baseURL = [NSURL URLWithString:@"http://example.com/v1/"]</code>http://example.com/v1/<code>"]</code></p>
    ```
    
    With patch:
    ```html
    <p><code>NSURL *baseURL = [NSURL URLWithString:@"http://example.com/v1/"]</code></p>
    ```
    
    The test case does indeed cover this problem but certainly could be improved.
    authored June 15, 2013

Jun 12, 2013

  1. Fábio Bernardo

    Added a new option to change the default alphabetical order of instan…

    …ce methods to the code order.
    authored June 12, 2013

Feb 25, 2013

  1. tomaz

    Fixed @since processing. Closes #320.

    authored February 25, 2013

Feb 02, 2013

  1. Fixed the array access beyond bounds.

    authored February 02, 2013

Dec 15, 2012

  1. Pedro Kroger

    Backslash needs to be escaped

    authored December 14, 2012

Dec 14, 2012

  1. tomaz

    Fixed overview section generation.

    The regression was introduced with one of recent contributions. My guess is the contributor was using older code base and didn't update before issuing pull request. The same issue repeated second time, to prevent further regressions, I added a comment to source code specifically guarding against changing affected lines. Not the best approach, but at least something until 3.0 is out...
    authored December 14, 2012

Dec 12, 2012

  1. Bilge Taylan Ulusoy

    Ability to parse @deprecated block

    @deprecated content will be added to the abstract block as "(<b class="deprecated">Deprecated:</b><span class="deprecated"> deprecated message here</span>)"
    
    Signed-off-by: Bilge Taylan Ulusoy <bilge.ulusoy@me.com>
    authored December 12, 2012

Oct 30, 2012

  1. Bilge Taylan Ulusoy

    Ability to parse @discussion @abstract @brief @details

    Signed-off-by: Bilge Taylan Ulusoy <bilge.ulusoy@me.com>
    authored October 30, 2012

Sep 02, 2012

  1. Dominik Pich

    'fixed' warnings & analyzer issues

    Signed-off-by: Dominik Pich <Dominik@pich.info>
    authored September 02, 2012

Aug 13, 2012

  1. kenji21

    Fixing links with custom title detection (custom titles like [this me…

    …thod] now works) and markdown generation. Refs #237
    authored August 13, 2012
  2. kenji21

    Tests and implementation for links with references to [Class method] …

    …with custom title. Refs #237
    authored August 13, 2012

Mar 10, 2012

  1. Jon Klein

    fix crash when making cross reference from static markdown document

    authored March 10, 2012

Mar 08, 2012

  1. tomaz

    When merging method documentation, section name is also copied if ori…

    …ginal name is nil. Closes #199.
    authored March 08, 2012

Mar 02, 2012

  1. Jerry Jones

    Add support for @note tags.

    Add support for printing titles of information blocks.
    
    Apple displays "Note:" in bold at the start of their note documentation. We'd like to do the same for warnings and bugs. This is now the default, and can be turned turned on/off with the 'print-information-block-titles' setting.
    authored March 02, 2012
  2. Jerry Jones

    Sanity check bounds when attempting to get substrings

    authored March 01, 2012

Feb 25, 2012

  1. tomaz

    Self references don't form links. Closes #190.

    This covers the following cases:
    
    - Cross reference to "current" class, category or protocol.
    - Cross reference to "current" method or property.
    authored February 25, 2012
  2. tomaz

    Fixed compiler warnings after upgrading to Xcode 4.3. Closes #186.

    authored February 25, 2012

Feb 23, 2012

  1. tomaz

    When merging categories to classes, their comment is also merged. Add…

    …resses #117.
    
    This is on by default, but can be controlled through `--merge-category-comment` cmd line switch.
    authored February 23, 2012

Dec 08, 2011

  1. tomaz

    Fixed usage of single star as bold marker (kind of). Closes #154.

    The problem with star delimited unordered lists was in appledoc comment preprocessor which consumed single star and replaced them with double star markers so that text would be emitted in bold. That's actually a feature of appledoc which allows single stars be used for bold markers, but may break compatibility with Markdown as the result. As there's no reliable way of determining whether the user wants to have star delimited, I decided to go the route I had in my mind for some time now: introduce another command line switch that would prevent handling single stars. It's on/off solution, so not the best one, but everyone can choose at least... Also updated [online documentation](http://gentlebytes.com/appledoc-docs-examples-basic/index.html#compatibility) with example of using the new switch.
    
    **Important:** As of this version on, single star handling is **off** by default! This may break backwards compatibility with some folks, but I feel it's better to keep as Markdown compatible for new people as possible...
    authored December 08, 2011

Sep 08, 2011

  1. Dan Jackson

    Fixed typo in log message: "Checking for known superclasses and adopt…

    …ed protocols..."
    authored September 08, 2011

Aug 19, 2011

  1. Maarten Billemont

    Added support for excluding paths from the output.

    This is useful if you only want to generate documentation for certain
    sources but those sources depend on other sources that should not have
    documentation generated for them.  With this feature, you add all
    sources as input and exclude certain sources from output generation.  It
    will hide warnings on excluded sources, not generate output for them,
    but they will be used for merging with your included sources (eg.
    inheritance etc.)
    authored August 19, 2011

Jul 11, 2011

  1. Mathieu Monney

    Added support for availability comment.

    Using @since or @available comment in a method description will generate a new section in the method doc. called "Availability". The content of that section will be the text following the @since or @available tag.
    authored July 11, 2011

May 26, 2011

  1. tomaz

    Fixed Xcode integration warnings and errors full paths handling. Fixes

    …#105.
    
    To allow Xcode properly open the file after selecting the warning in build list, it requires full path to it in the output, so I had to add full path to GBSourceInfo and use that when generating Xcode compatible log.
    
    Note that I had appledoc crashed inside `[GBLog logFormatterForLogFormat]` when using standard log formats. The problem was with sending the given format instance `lowercaseString` however in case numerical value was used, the actual instance was `NSNumber`. To compensate, additional check was added to make sure the instance is indeed a `NSString`. Strange no one reported this as I didn't touch this code since last pushing to GitHub (or everyone was hardly waiting for Xcode compatibility and are now using that mode :).
    
    Also added `xcode` log format option to help output and increased build number to 701.
    authored May 26, 2011

May 25, 2011

  1. tomaz

    Implemented better Xcode integration for warnings and errors. Closes #…

    …105.
    
    By using special log format `--logformat xcode`, appledoc formats warnings and errors related to source files in a way that Xcode is able to catch them and display them in build results. Currently only warnings are using that format (there is no error log message related to source files).
    
    *Implementation details:* Note that implementation required tweaking Cocoa Lumberjack source. Specifically, it required passing in original source code filename and line number to log message. Although logging macros pick up source file and line automatically through `__FILE__` and `__LINE__`, these belong to appledoc sources. But for Xcode warnings making sense, we need to write the file name and line of the context being parsed. To reuse existing macros, I added both values to DDMessage and additional class method to DDLog which needs to be called prior to logging. The method will simply store info to static vars. Then logging method will pick up stored values, write them to message and reset static vars. When emitting log messages, Xcode formatter will check if these values are set and emit specially formatted logs, otherwise it will revert to message only.
    
    *Additional note:* Although I searched for all occurrences of `GBLogWarn` and `GBLogError` in the project and updated those that seemed relevant, some may have been left out - let me know about exact messages and I will check it. Also note that parsing code currently doesn't emit warnings, if something goes wrong, exceptions are raised, which doesn't log the file and line. Didn't take much time to go into this as these usually indicate parsing code needs to be refined.
    authored May 25, 2011

May 10, 2011

  1. tomaz

    Fixed methods being reported in several sections after merging catego…

    …ries into classes.
    
    Although model objects properly merged sections from categories, resulting in empty sections if there were no methods in there, HTML generator rendered existing methods in these sections as if they were actually registered. Although this might require further investigation to really fix the issue (i.e. why output generator doesn't render empty section, why it adds methods to it?), current solution simply removes all empty sections after merging.
    
    Also updated build number to 694.
    authored May 10, 2011
Something went wrong with that request. Please try again.