8000 GitHub - cheoljoo/doxygen_perlmod_python at 4e712909e818156462b114dbbcade40e443d6462
[go: up one dir, main page]

Skip to content

cheoljoo/doxygen_perlmod_python

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

doxygen_perlmod_python

  • developers want to use parsing data from doxygen.
  • they want to do something with python.

Doxyfile

  • set GENERATE_PERLMOD = YES and PERLMOD_PYTHON = YES
  • it gives more examples and usage when you set PERLMOD_PYTHON to YES in Doxyfile

markdown output with plantuml

  • make test1
  • source : test-1
  • Doxyfile
    • GENERATE_PERLMOD = YES
    • PERLMOD_PYTHON = YES
    • INPUT = ../doxygen-test-src
    • PLANTUML_JAR_PATH = ./plantuml.jar
      • but we do not copy proper plantuml.jar. we use 'touch plantuml.jar' to remove java running time.
  • output
    • test-1/output/perlmod/output.md : show markdown including plantuml with vscode (useful extension : markdown preview enhanced)
  • if you find some Error when you run doxygen , it is no problem.
    • show link to know the reason

html output using plantuml server

  • above all you set plantuml server in your accessing server with docker
    • $ docker run -d -p 18080:8080 plantuml/plantuml-server:tomcat
      • you can change into your port # instead of 18080. we will use like http://[yourhostname]:18080/.
    • you need to install and run docker image. then you should set your hostname and port # in src/mysetting.py
  • make testserver
  • source : test-server
  • Doxyfile
    • GENERATE_PERLMOD = YES
    • PERLMOD_PYTHON = YES
    • INPUT = ../doxygen-test-src
    • PLANTUML_JAR_PATH = ./plantuml.jar
      • but we do not copy proper plantuml.jar. we use 'touch plantuml.jar' to remove java running time.
  • if you find some Error when you run doxygen , it is no problem.
    • show link to know the reason
  • todo
    • make alternative url in html : we can use png file when we have some error to connect to plantuml server

make plantuml with hpp2plantuml

html with mako (python module)

  • sample-mako.py

About

gives more python examples and usage when you set GENERATE_PERLMOD in doxygen

Topics

Resources

License

Stars

Watchers

Forks

0