Skip to content

Commit

Permalink
doxygen: add pages for help
Browse files Browse the repository at this point in the history
  • Loading branch information
flatcap committed Aug 14, 2019
1 parent 31b022a commit 61576ea
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 2 deletions.
2 changes: 1 addition & 1 deletion help.c
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
*/

/**
* @page help Generate the help-line and help-page and GUI display them
* @page help_page Generate the help-line and help-page and GUI display them
*
* Generate the help-line and help-page and GUI display them
*/
Expand Down
6 changes: 6 additions & 0 deletions help/help.c
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@
* this program. If not, see <http://www.gnu.org/licenses/>.
*/

/**
* @page help_help Help system
*
* Help system
*/

#include "config.h"
#include <stddef.h>
#include <errno.h>
Expand Down
14 changes: 13 additions & 1 deletion help/help.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* @file
* Help system
* Help Viewer
*
* @authors
* Copyright (C) 2018-2019 Richard Russon <rich@flatcap.org>
Expand All @@ -22,6 +22,18 @@
* this program. If not, see <http://www.gnu.org/licenses/>.
*/

/**
* @page help HELP: Help Viewer
*
* Help Viewer
*
* | File | Description |
* | :---------------- | :----------------------- |
* | help/help.c | @subpage help_help |
* | help/scan.c | @subpage help_scan |
* | help/vector.c | @subpage help_vector |
*/

#ifndef MUTT_HELP_HELP_H
#define MUTT_HELP_HELP_H

Expand Down
6 changes: 6 additions & 0 deletions help/scan.c
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@
* this program. If not, see <http://www.gnu.org/licenses/>.
*/

/**
* @page help_scan Scan a directory with nftw
*
* Scan a directory with nftw
*/

#include <ftw.h>
#include <string.h>
#include <stdio.h>
Expand Down
6 changes: 6 additions & 0 deletions help/vector.c
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@
* this program. If not, see <http://www.gnu.org/licenses/>.
*/

/**
* @page help_vector Expandable array
*
* Expandable array
*/

#include <stdio.h>
#include <stdlib.h>
#include "mutt/mutt.h"
Expand Down

0 comments on commit 61576ea

Please sign in to comment.