Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
Full GitLab CI integration, which lead to fixing some bugs in the code detected by the tests too.
Also changed the way to generate most links to be route-based.
This is the first stable 7.x-2.x branch release. The 7.x-2.x branch is quite different from the 7.x-1.x branch -- it uses 3rd-party libraries for parsing the code, in place of the Grammar Parser project. Installing this release or updating from the 7.x-1.x branch requires Composer. See https://www.drupal.org/docs/7/modules/api-module/create-your-own-api-7x-...
for installation and upgrading instructions.
- In the Search block provided by this module, the keywords field label is now visually hidden (still available for screen readers).
- The Navigation block provided by this module has settings so you can display/hide it based on what type of API page is being displayed. By default it is displayed on all types of API pages. It is no longer visible on pages that are not provided by the API module.
Generally speaking... If you update to a development branch, you may need to reparse your files in order to see bug fixes and new features in action. We put in an update hook (as needed) when we make a release that will mark necessary files for reparsing, but we don't do that with each change in a development branch. (You can use Drush commands or the admin interface to mark various branches for reparsing.)
Note that there is an update function that reparses all code, to take care of the "reparse" notes in the release notes below. Until that is done, some features may not be fully active. Also you'll need to clear your cache and possibly make some theme updates.
Changes since the 7.x-1.7 release -- note that you'll need to run update.php and then run cron until affected files are reparsed, to see some of the changes:
The Traits update requires a corresponding change in the Grammar Parser project. You will need to download the 7.x-2.x development version of Grammar Parser (or any 2.x release from on or after June 21, 2014) -- see https://www.drupal.org/project/grammar_parser to download
Notes about the changes below:
- Some changes involved updates to the API module's default Views. If you have overridden views, you may not get the changes. These are marked (*).
- Some changes will require you to re-parse source code to get the fixes. If you run update.php, this will be queued up; then you'll need to run cron and/or parse queues until it's done. These parsing changes mostly affect when parsing Drupal 8.x code, and are marked with (**) below.
Changes since version 7.x-1.4 include both bug fixes and new features.
Note that the one of the new features is to support displaying Deprecated code. This will not work correctly without a patch in the Views module for this issue: #2006560: The boolean string filter doesn't result in correct where clause
At the time of this API module release, this patch has not been added to Views.
Important: This release requires version 7.x-2.1 or later of both Grammar Parser and Grammar Parser Library, plus Views 7.x. Using a released version of Grammar Parser Library is recommended; if you are using a development/Git version, you'll need to put the 7.x-2.1 version into the .info file for Grammar Parser Library.
1. Bug fix: The parsing code had a problem when encountering two closures (which amount to unnamed functions) in the same file during parsing, which would cause a fatal database error. That is fixed -- unnamed objects are now not saved as documentation objects. (There was a vendor file in 8.x that triggered this problem.)
2. Feature: YAML, CSS, and a few additional file types/extensions are now parsed/displayed as plain-text files.
If you are running the 6.x version of the API module, read the documentation on how to upgrade; if you are installing for the first time, read the installation documentation. Both are at: http://drupal.org/node/425940
Changes since version 7.x-1.0 include bug fixes and new features, mostly fairly minor:
- Lists at top of function, class, file, etc. pages of the same item name in different branches are now limited to be within the current project only. (issue)
- Drupal 8 @Plugin annotations in plugin classes are now parsed and displayed in documentation. (issue)
- For the "N Functions that call this one" and similar sections (theme invokes, etc.), there is now an expand/contract section that shows the first few results, and a link to the rest, so you don't have to visit another page to see at least some of these links. (issue)
- There's a new "N methods override this method" link/section on method pages. (issue)
- In @code sections of documentation, functions etc. now turn into links like they do in the main source listings. (issue)
- Links to documented global variables are now made. (issue)
- The search box is wider in the default CSS. (issue)
First official 7.x version of the API module! If you are running the 6.x version of the API module, read the documentation on how to upgrade; if you are installing for the first time, read the installation documentation. Both are at: http://drupal.org/node/425940
Note: This release is only compatible with the 7.x-2.x branch of Grammar Parser.
Eighth beta-test release of the 7.x version of the API module -- three small changes since the last release. It's closer to ready for release, but there are still some known issues. Check the API module issue queue for an updated status, and please report any problems you see that aren't already there.
Note: In some versions of PHP, PHP itself may crash when parsing some Drupal Core files. Not sure how to fix that...
Note: This release is only compatible with the 7.x-2.x branch of Grammar Parser.
Seventh beta-test release of the 7.x version of the API module -- with some bug fixes and since the last beta release, and the addition of Views integration. Also, as noted above, the code was changed so that it works with the 7.x branch of Grammar Parser. It's closer to ready for release, but there are still some known issues. Check the API module issue queue for an updated status, and please report any problems you see that aren't already there.