function documentatio not showing up

Brought to you by: jordan2175

function documentatio not showing up

Forum: General Discussion

Creator: mishkind

Created: 2015-01-12

Updated: 2015-03-20

mishkind - 2015-01-12

I'm new to doxygen and this perl module. My simple perl module test
code (file.pm) looks like:

1 2 3 4 5 6 7 8 9 10 11
#! /usr/bin/perl use Doxygen::Filter::Perl; #** @function public intest2 # Description of intest2 #* sub intest2(){ return 8; } return 1;

And then I copied over the sample Doxyfile to the root directory, and placed
the above file.pm in lib/ and I ran doxygen Doxyfile, which creates a
doc/html/index.html and indeed it has the list of files, but I don't
have the function description. Am I missing something?
I tried EXTRACT_ALL = YES in the Doxyfile but that didn't work either.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

lkisac - 2015-02-19

I'm also experiencing the same issue. I'm able to click a link to view the source code, but I don't see the generated documentation.

I tried the steps from this thread, with versions 1.00, 1.01 and the latest 1.8.9.1.

I tested different configuration options and noticed the html docs now displays a 'Go to the documentation of this file' link(I'm not sure which option did that, it might have been GENERATE_PERLMOD), but the documentation page is still empty with a link that says 'Go to the source code of this file'.

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Bret Jordan - 2015-02-19

I will need to look in to this and see what is going on.

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

woodz - 2015-02-21

Aloha,

I am having the same issue. There are some obsolete warnings, which I'd like to post here:

Warning: Tag `HTML_ALIGN_MEMBERS' at line 873 of file doxyfile has become obsolete
HTML_ALIGN_MEMBERS = YES

Warning: Tag `SHOW_DIRECTORIES' at line 512 of file doxyfile has become obsolete
SHOW_DIRECTORIES = NO

Warning: Tag `SYMBOL_CACHE_SIZE' at line 303 of file doxyfile has become obsolete
SYMBOL_CACHE_SIZE = 0

Warning: Tag `USE_INLINE_TREES' at line 1060 of file doxyfile has become obsolete
USE_INLINE_TREES = NO

Thanks in advance.

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

woodz - 2015-02-21

Aloha once more,

I guess I got it to work. Please try setting the following tags in the doxyfile:

EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES

It seems the default setup of the release is all of these set to 'NO'

Please let me know if you get something useful by then.

Thanks in advance

Last edit: woodz 2015-02-21

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
- lkisac - 2015-02-23
  
  Hi,
  
  I set the 3 tags to YES in Doxyfile, but I'm still getting empty documentation, only source code is showing.
  
  Thanks
  
  If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

woodz - 2015-02-21

Aloha again,

what I else found out:

the '@params' parameter specifier does not produce very well formatted html. If I change it to '@param' then it does. Although the [reqired|optional] options do even not get well formed attributes. Of course you can format by your own, but ...

This was only tested for functions in no specific class, the implicit main class. It might be deifferent when having well designed classes.

Tanks in advance

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Bret Jordan - 2015-03-16

I have fixed the output problem and will be releasing a new version on CPAN and Github at: https://github.com/jordan2175/doxygen-filter-perl

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
- lkisac - 2015-03-17
  
  I downloaded the latest update 1.70. It's working now and looks great. Thanks!
  
  If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Bret Jordan - 2015-03-17

I made another small change for another user on stackexchange and have published 1.71

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
- lkisac - 2015-03-19
  
  Hi Bret,
  
  I just now tested pl files and am also experiencing the same issue from the stack thread with subroutine documentation not showing. I tried with the same example from the thread and doxygen versions mentioned there (1.7.5.1, 1.8.6, and latest 1.8.9.1) but it's still not working.
  
  I made sure to my Windows PATH was updated while testing each version with:
  "doxygen -h"
  
  Doxygen still seems to be stopping at the my variable declaration, i.e. my $b (line 15).
  It shows this message in the Detailed Description: "Definition at line 15 of file test_doxygen.pl"
  
  Regards,
  Len
  
  Last edit: lkisac 2015-03-19
  
  If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Bret Jordan - 2015-03-19

Are you running 1.71 of Doxygen::Filter::Perl? Have you replaced your Doxyfile with the new on in the 1.71 distribution?

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
- lkisac - 2015-03-19
  
  Yes, I copied the new Doxyfile (1.71) into my script's location. I also ran doxygen Doxyfile from C:\Doxygen-Filter-Perl-1.71. Issue still occurs if I change the variables in Perl.pm and Filter.pm from our to my.
  
  If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Bret Jordan - 2015-03-19

In the Doxyfile file, try changing the EXTRACT_PRIVATE = NO to EXTRACT_PRIVATE = YES and let me know if it works.

If it does not work, please run the ./doxygen-filter-perl yourexamplecode.pl and post it. The code in the example file needs to show the problem. Or you can post a code sample that shows the problem.

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
- lkisac - 2015-03-20
  
  It works now. Thanks!
  
  If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Log in to post a comment.