[Doxygen-users] VHDL: functions only in package body not shown

[Jacob V. d. W. <J.v...@3t...>]

Hello,

further evaluating DoxyGen for VHDL:
Comments on functions placed in only the package body (so without 
prototype in the package header) are not shown in the DoxyGen outpu.

Using the following test package:
--! @file
--! @brief a package with functions
--! The functions are private, only in the package body
--! Normaly there should be at least one public function
--! that accesses the private function, but left out for now ....

--! @brief This is the package header description ...
--! For now the package header is empty

PACKAGE func_pack IS

END func_pack;

--! @brief This is the package body description ...
--! Only private function for testing

PACKAGE BODY func_pack IS

   --! @brief Function3 prototype
   --! @param[in] param1 first parameter of function3
   --! @return the return value of function3
   FUNCTION function3(CONSTANT param1 : IN integer) RETURN integer IS
   BEGIN
     RETURN param1;
   END FUNCTION function3;

END func_pack;

The function 'function3' is not listed anywhere in the DoxyGen output. 
Both the function and the comment for it.

To get it listed I have (also) enabled the following options that are 
not enabled by default:
EXTRACT_PRIVATE       = YES
EXTRACT_PACKAGE       = YES
EXTRACT_STATIC        = YES
EXTRACT_LOCAL_METHODS = YES
EXTRACT_ANON_NSPACES  = YES
HIDE_IN_BODY_DOCS     = YES
INTERNAL_DOCS         = YES
FORCE_LOCAL_INCLUDES  = YES

Is there a way to list these functions?

Kind regards,
Jacob















-- 

Jacob Van der Woude (J.v...@3t...)

______________________________________________________________
3T B.V.
Institutenweg 6 - NL-7521 PK - Enschede
Tel.: +31(0)53-4336633 - Fax: +31(0)53-4336869
Internet: http://www.3t.nl