diff mbox series

doc: add deprecated list in doxygen

Message ID 20181018160916.23180-1-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: add deprecated list in doxygen |

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Thomas Monjalon Oct. 18, 2018, 4:09 p.m. UTC 
  The option GENERATE_DEPRECATEDLIST will create a page
"Deprecated List" in "Related Pages" menu.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/api/doxy-api.conf.in | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Ferruh Yigit Oct. 18, 2018, 4:16 p.m. UTC | #1 
On 10/18/2018 5:09 PM, Thomas Monjalon wrote:
> The option GENERATE_DEPRECATEDLIST will create a page
> "Deprecated List" in "Related Pages" menu.

+1

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>

> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
>  doc/api/doxy-api.conf.in | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in
> index c3d8fdef1..3b652ac9c 100644
> --- a/doc/api/doxy-api.conf.in
> +++ b/doc/api/doxy-api.conf.in
> @@ -74,7 +74,7 @@ DISTRIBUTE_GROUP_DOC    = YES
>  HIDE_UNDOC_MEMBERS      = YES
>  HIDE_UNDOC_CLASSES      = YES
>  HIDE_SCOPE_NAMES        = YES
> -GENERATE_DEPRECATEDLIST = NO
> +GENERATE_DEPRECATEDLIST = YES
>  VERBATIM_HEADERS        = NO
>  ALPHABETICAL_INDEX      = NO
>  
>
Thomas Monjalon Oct. 25, 2018, 2:37 p.m. UTC | #2 
18/10/2018 18:16, Ferruh Yigit:
> On 10/18/2018 5:09 PM, Thomas Monjalon wrote:
> > The option GENERATE_DEPRECATEDLIST will create a page
> > "Deprecated List" in "Related Pages" menu.
> 
> +1
> 
> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>

Applied
diff mbox series

Patch

diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in
index c3d8fdef1..3b652ac9c 100644
--- a/doc/api/doxy-api.conf.in
+++ b/doc/api/doxy-api.conf.in
@@ -74,7 +74,7 @@  DISTRIBUTE_GROUP_DOC    = YES
 HIDE_UNDOC_MEMBERS      = YES
 HIDE_UNDOC_CLASSES      = YES
 HIDE_SCOPE_NAMES        = YES
-GENERATE_DEPRECATEDLIST = NO
+GENERATE_DEPRECATEDLIST = YES
 VERBATIM_HEADERS        = NO
 ALPHABETICAL_INDEX      = NO