examples.module 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  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
  16. * functionality.
  17. *
  18. * Developers can learn how to use a particular API quickly by experimenting
  19. * with the examples, and adapt them for their own use.
  20. *
  21. * Download the Examples for Developers Project (and participate with
  22. * submissions, bug reports, patches, and documentation) at
  23. * http://drupal.org/project/examples
  24. */
  25. /**
  26. * Implements hook_help().
  27. */
  28. function examples_help($path, $arg) {
  29. // re: http://drupal.org/node/767204
  30. // 5. We need a master group (Examples) that will be in a main
  31. // examples.module.
  32. // The examples.module should be mostly doxy comments that point to the other
  33. // examples. It will also have a hook_help() explaining its purpose and how
  34. // to access the other examples.
  35. }
  36. /**
  37. * @} End of 'defgroup examples'.
  38. */