examples.module

Tracking 8.x-1.x branch
  1. drupal
    1. 6 contributions/examples/examples.module
    2. 7 contributions/examples/examples.module
    3. 8 contributions/examples/examples.module

This file serves as a stub file for the many Examples modules in the Examples for Developers Project which you can download and experiment with.

One might say that examples.module is an example of documentation. However, note that the example submodules define many doxygen groups, which may or may not be a good strategy for other modules.

Functions & methods

NameDescription
examples_helpImplements hook_help().

File

View source
  1. <?php
  2. /**
  3. * @file
  4. * This file serves as a stub file for the many Examples modules in the
  5. * @link http://drupal.org/project/examples Examples for Developers Project @endlink
  6. * which you can download and experiment with.
  7. *
  8. * One might say that examples.module is an example of documentation. However,
  9. * note that the example submodules define many doxygen groups, which may or
  10. * may not be a good strategy for other modules.
  11. */
  12. /**
  13. * @defgroup examples Examples
  14. * @{
  15. * Well-documented API examples for a broad range of Drupal 7 core functionality.
  16. *
  17. * Developers can learn how to use a particular API quickly by experimenting
  18. * with the examples, and adapt them for their own use.
  19. *
  20. * Download the Examples for Developers Project (and participate with
  21. * submissions, bug reports, patches, and documentation) at
  22. * http://drupal.org/project/examples
  23. */
  24. /**
  25. * Implements hook_help().
  26. */
  27. function examples_help($path, $arg) {
  28. // re: http://drupal.org/node/767204
  29. // 5. We need a master group (Examples) that will be in a main
  30. // examples.module.
  31. // The examples.module should be mostly doxy comments that point to the other
  32. // examples. It will also have a hook_help() explaining its purpose and how
  33. // to access the other examples.
  34. }
  35. /**
  36. * @} End of 'defgroup examples'.
  37. */