Doxygen

  • Creatore
    Topic
  • #44632
    Up
    0
    Down
    ::


    Ciao ragazzi,

    ho bisogno di una mano per la stesura della tesi di laurea.

    Dunque, come lavoro di tesi ho sviluppato un codice Python e ho creato la sua documentazione Doxygen. Quel che vorrei fare ora è di andare ad inserire questa documentazione nella mia tesi. Il problema è che la cosa non è immediata in quanto i file latex generati dal Doxywizard non sono inseribili in appendice semplicemente con /input{refman}.

    Sapete aiutarmi?

    Grazie,

    Samuele.

Visualizzazione 7 filoni di risposte
  • Autore
    Risposte
    • #44633
      Up
      0
      Down
      ::


      se hai attivato l’opzione COMPACT_LATEX in doxygen il refman generato sara’ composto solo da sezioni e sottosezioni.
      modifica (o meglio copia) il file refman.tex ed elimina il preambolo, il \begin e l’\end{document} e aggiungi un \appendix{quellochetipare} in testa.
      ora dovresti essere in grado di includerlo facilmente nel documento principale.
      mi raccomando controlla di avere nel preambolo tutti i pacchetti richiesti da doxygen (comprensivo del doxygen.sty) configurati come di dovere.
      e cambia quel pessimo font times che usa!!
      ti consiglio l’inconsolata per le parti di codice, molto carino, compatto e leggibile anche a dimensioni ridotte.

    • #44634
      Up
      0
      Down
      ::


      Ciao e grazie mille per la risposta..
      Dunque, andiamo per punti che non sono espertissimo né di Doxygen, né di Latex..
      1. certo, cambio carattere che non mi piace.
      2. inconsolata = verbatim?? Oppure non c’entra nulla? Nel caso, cosa devo scrivere?
      3. come faccio ad attivare l’opzione “compact_latex”? Cioè, mi spiego: devo rigenerare la documentazione digitando qualche opzione oltra a “doxygen nomefile”?? Oppure basta che prenda il mio refman, elimini preambolo, \begin{document} ed \end{document}?? Credo che così non sia possibile, altrimenti come fa a modificarmi in automatico chapter con section, section con subsection e così via?? Io l’ho fatto a mano, ma è una follia.

      Grazie ancora,
      Samuele

    • #44635
      Up
      0
      Down
      ::

      1. certo, cambio carattere che non mi piace.

      ben fatto

      2. inconsolata = verbatim?? Oppure non c’entra nulla? Nel caso, cosa devo scrivere?

      inconsolata e’ un font di tipo typewriter, quindi andra’ a modificare il carattere visualizzato negli ambienti verbatim.
      per usarlo inserisci

      `\usepackage[T1]{fontenc}
      \usepackage{inconsolata}`

      potresti non averlo installato nella tua distribuzione, ma e’ tra quelli direttamente disponibili per LaTeX. maggiori info qui, ad esempio.

      3. come faccio ad attivare l’opzione “compact_latex”? Cioè, mi spiego: devo rigenerare la documentazione digitando qualche opzione oltra a “doxygen nomefile”?? Oppure basta che prenda il mio refman, elimini preambolo, \begin{document} ed \end{document}?? Credo che così non sia possibile, altrimenti come fa a modificarmi in automatico chapter con section, section con subsection e così via?? Io l’ho fatto a mano, ma è una follia.

      l’opzione COMPACT_LATEX va data all’interno del doxyfile che genera la documentazione (o equivalentemente all’interno di doxywizard, nella sezione expert/latex).
      fara’ in modo che il file generato sia un article con solo sezioni e sottosezioni.

    • #44636
      Up
      0
      Down
      ::


      Scusa ma non ho capito una cosa: ho modificato il Doxyfile (lo puoi leggere qui sotto), mettendo YES alla voce “Compact Latex”. Ma non cambia nulla, nel senso che ho ancora il file diviso in capitoli.

      Mi sai aiutare? Grazie.

      `
      # Doxyfile 1.5.6

      #—————————————————————————
      # Project related configuration options
      #—————————————————————————
      DOXYFILE_ENCODING = UTF-8
      PROJECT_NAME = VMTKGui
      PROJECT_NUMBER = 1.0
      OUTPUT_DIRECTORY = /home/samiam/Documents/TESI/gui_python/doxygen/
      CREATE_SUBDIRS = NO
      OUTPUT_LANGUAGE = English
      BRIEF_MEMBER_DESC = YES
      REPEAT_BRIEF = YES
      ABBREVIATE_BRIEF = “The $name class” \
      “The $name widget” \
      “The $name file” \
      is \
      provides \
      specifies \
      contains \
      represents \
      a \
      an \
      the
      ALWAYS_DETAILED_SEC = NO
      INLINE_INHERITED_MEMB = NO
      FULL_PATH_NAMES = YES
      STRIP_FROM_PATH = /home/samiam/Documents/TESI/gui_python/
      STRIP_FROM_INC_PATH =
      SHORT_NAMES = NO
      JAVADOC_AUTOBRIEF = NO
      QT_AUTOBRIEF = NO
      MULTILINE_CPP_IS_BRIEF = NO
      DETAILS_AT_TOP = NO
      INHERIT_DOCS = YES
      SEPARATE_MEMBER_PAGES = NO
      TAB_SIZE = 8
      ALIASES =
      OPTIMIZE_OUTPUT_FOR_C = NO
      OPTIMIZE_OUTPUT_JAVA = NO
      OPTIMIZE_FOR_FORTRAN = NO
      OPTIMIZE_OUTPUT_VHDL = NO
      BUILTIN_STL_SUPPORT = NO
      CPP_CLI_SUPPORT = NO
      SIP_SUPPORT = NO
      IDL_PROPERTY_SUPPORT = YES
      DISTRIBUTE_GROUP_DOC = NO
      SUBGROUPING = YES
      TYPEDEF_HIDES_STRUCT = NO
      #—————————————————————————
      # Build related configuration options
      #—————————————————————————
      EXTRACT_ALL = YES
      EXTRACT_PRIVATE = YES
      EXTRACT_STATIC = YES
      EXTRACT_LOCAL_CLASSES = YES
      EXTRACT_LOCAL_METHODS = NO
      EXTRACT_ANON_NSPACES = NO
      HIDE_UNDOC_MEMBERS = NO
      HIDE_UNDOC_CLASSES = NO
      HIDE_FRIEND_COMPOUNDS = NO
      HIDE_IN_BODY_DOCS = NO
      INTERNAL_DOCS = NO
      CASE_SENSE_NAMES = YES
      HIDE_SCOPE_NAMES = NO
      SHOW_INCLUDE_FILES = YES
      INLINE_INFO = YES
      SORT_MEMBER_DOCS = YES
      SORT_BRIEF_DOCS = NO
      SORT_GROUP_NAMES = NO
      SORT_BY_SCOPE_NAME = NO
      GENERATE_TODOLIST = YES
      GENERATE_TESTLIST = YES
      GENERATE_BUGLIST = YES
      GENERATE_DEPRECATEDLIST= YES
      ENABLED_SECTIONS =
      MAX_INITIALIZER_LINES = 30
      SHOW_USED_FILES = YES
      SHOW_DIRECTORIES = NO
      SHOW_FILES = YES
      SHOW_NAMESPACES = YES
      FILE_VERSION_FILTER =
      #—————————————————————————
      # configuration options related to warning and progress messages
      #—————————————————————————
      QUIET = NO
      WARNINGS = YES
      WARN_IF_UNDOCUMENTED = YES
      WARN_IF_DOC_ERROR = YES
      WARN_NO_PARAMDOC = NO
      WARN_FORMAT = “$file:$line: $text”
      WARN_LOGFILE =
      #—————————————————————————
      # configuration options related to the input files
      #—————————————————————————
      INPUT = /home/samiam/Documents/TESI/gui_python/
      INPUT_ENCODING = UTF-8
      FILE_PATTERNS = *.c \
      *.cc \
      *.cxx \
      *.cpp \
      *.c++ \
      *.d \
      *.java \
      *.ii \
      *.ixx \
      *.ipp \
      *.i++ \
      *.inl \
      *.h \
      *.hh \
      *.hxx \
      *.hpp \
      *.h++ \
      *.idl \
      *.odl \
      *.cs \
      *.php \
      *.php3 \
      *.inc \
      *.m \
      *.mm \
      *.dox \
      *.py \
      *.f90 \
      *.f \
      *.vhd \
      *.vhdl \
      *.C \
      *.CC \
      *.C++ \
      *.II \
      *.I++ \
      *.H \
      *.HH \
      *.H++ \
      *.CS \
      *.PHP \
      *.PHP3 \
      *.M \
      *.MM \
      *.PY \
      *.F90 \
      *.F \
      *.VHD \
      *.VHDL
      RECURSIVE = NO
      EXCLUDE =
      EXCLUDE_SYMLINKS = NO
      EXCLUDE_PATTERNS =
      EXCLUDE_SYMBOLS =
      EXAMPLE_PATH =
      EXAMPLE_PATTERNS = *
      EXAMPLE_RECURSIVE = NO
      IMAGE_PATH =
      INPUT_FILTER =
      FILTER_PATTERNS =
      FILTER_SOURCE_FILES = NO
      #—————————————————————————
      # configuration options related to source browsing
      #—————————————————————————
      SOURCE_BROWSER = YES
      INLINE_SOURCES = NO
      STRIP_CODE_COMMENTS = YES
      REFERENCED_BY_RELATION = YES
      REFERENCES_RELATION = YES
      REFERENCES_LINK_SOURCE = YES
      USE_HTAGS = NO
      VERBATIM_HEADERS = YES
      #—————————————————————————
      # configuration options related to the alphabetical class index
      #—————————————————————————
      ALPHABETICAL_INDEX = NO
      COLS_IN_ALPHA_INDEX = 5
      IGNORE_PREFIX =
      #—————————————————————————
      # configuration options related to the HTML output
      #—————————————————————————
      GENERATE_HTML = NO
      HTML_OUTPUT = html
      HTML_FILE_EXTENSION = .html
      HTML_HEADER =
      HTML_FOOTER =
      HTML_STYLESHEET =
      HTML_ALIGN_MEMBERS = YES
      GENERATE_HTMLHELP = NO
      GENERATE_DOCSET = NO
      DOCSET_FEEDNAME = “Doxygen generated docs”
      DOCSET_BUNDLE_ID = org.doxygen.Project
      HTML_DYNAMIC_SECTIONS = NO
      CHM_FILE =
      HHC_LOCATION =
      GENERATE_CHI = NO
      CHM_INDEX_ENCODING =
      BINARY_TOC = NO
      TOC_EXPAND = NO
      DISABLE_INDEX = NO
      ENUM_VALUES_PER_LINE = 4
      GENERATE_TREEVIEW = ALL
      TREEVIEW_WIDTH = 250
      FORMULA_FONTSIZE = 10
      #—————————————————————————
      # configuration options related to the LaTeX output
      #—————————————————————————
      GENERATE_LATEX = YES
      LATEX_OUTPUT = latex
      LATEX_CMD_NAME = latex
      MAKEINDEX_CMD_NAME = makeindex
      COMPACT_LATEX = YES
      PAPER_TYPE = a4wide
      EXTRA_PACKAGES =
      LATEX_HEADER =
      PDF_HYPERLINKS = YES
      USE_PDFLATEX = YES
      LATEX_BATCHMODE = NO
      LATEX_HIDE_INDICES = NO
      #—————————————————————————
      # configuration options related to the RTF output
      #—————————————————————————
      GENERATE_RTF = NO
      RTF_OUTPUT = rtf
      COMPACT_RTF = NO
      RTF_HYPERLINKS = NO
      RTF_STYLESHEET_FILE =
      RTF_EXTENSIONS_FILE =
      #—————————————————————————
      # configuration options related to the man page output
      #—————————————————————————
      GENERATE_MAN = NO
      MAN_OUTPUT = man
      MAN_EXTENSION = .3
      MAN_LINKS = NO
      #—————————————————————————
      # configuration options related to the XML output
      #—————————————————————————
      GENERATE_XML = YES
      XML_OUTPUT = xml
      XML_SCHEMA =
      XML_DTD =
      XML_PROGRAMLISTING = YES
      #—————————————————————————
      # configuration options for the AutoGen Definitions output
      #—————————————————————————
      GENERATE_AUTOGEN_DEF = NO
      #—————————————————————————
      # configuration options related to the Perl module output
      #—————————————————————————
      GENERATE_PERLMOD = NO
      PERLMOD_LATEX = NO
      PERLMOD_PRETTY = YES
      PERLMOD_MAKEVAR_PREFIX =
      #—————————————————————————
      # Configuration options related to the preprocessor
      #—————————————————————————
      ENABLE_PREPROCESSING = YES
      MACRO_EXPANSION = NO
      EXPAND_ONLY_PREDEF = NO
      SEARCH_INCLUDES = YES
      INCLUDE_PATH =
      INCLUDE_FILE_PATTERNS =
      PREDEFINED =
      EXPAND_AS_DEFINED =
      SKIP_FUNCTION_MACROS = YES
      #—————————————————————————
      # Configuration::additions related to external references
      #—————————————————————————
      TAGFILES =
      GENERATE_TAGFILE =
      ALLEXTERNALS = NO
      EXTERNAL_GROUPS = YES
      PERL_PATH = /usr/bin/perl
      #—————————————————————————
      # Configuration options related to the dot tool
      #—————————————————————————
      CLASS_DIAGRAMS = NO
      MSCGEN_PATH =
      HIDE_UNDOC_RELATIONS = YES
      HAVE_DOT = YES
      DOT_FONTNAME = FreeSans
      DOT_FONTPATH =
      CLASS_GRAPH = YES
      COLLABORATION_GRAPH = YES
      GROUP_GRAPHS = YES
      UML_LOOK = NO
      TEMPLATE_RELATIONS = NO
      INCLUDE_GRAPH = YES
      INCLUDED_BY_GRAPH = YES
      CALL_GRAPH = NO
      CALLER_GRAPH = NO
      GRAPHICAL_HIERARCHY = YES
      DIRECTORY_GRAPH = YES
      DOT_IMAGE_FORMAT = png
      DOT_PATH =
      DOTFILE_DIRS =
      DOT_GRAPH_MAX_NODES = 50
      MAX_DOT_GRAPH_DEPTH = 1000
      DOT_TRANSPARENT = YES
      DOT_MULTI_TARGETS = NO
      GENERATE_LEGEND = YES
      DOT_CLEANUP = YES
      #—————————————————————————
      # Configuration::additions related to the search engine
      #—————————————————————————
      SEARCHENGINE = NO
      `

    • #44637
      Up
      0
      Down
      ::


      ho utilizzato il tuo Doxyfile su un mio progetto (con le modifiche minime necessarie) e il refman che mi genera contiene \section invece di \chapter.
      l’unica differenza che posso notare e’ la versione di doxygen, la mia e’ 1.6.3 contro la tua un po’ piu’ antiquata.

    • #44638
      Up
      0
      Down
      ::


      Questa è bella..
      Mm.. Riprovo!

    • #44639
      Up
      0
      Down
      ::


      Ti giuro, ho riprovato,

      ma a me continua a lasciare i capitoli..

      Dove recupero la 1.6.3?? Che nei repo di Ubuntu c’è solo la 1.5.6 (che è quella che ho io!).. Hai idea??

      Altrimenti, come potrei fare?

    • #44640
      Up
      0
      Down
      ::


      Errata corrige: con la 1.6.3 funziona!! Eureka!!

      Grazie mille.

      Samuele

Visualizzazione 7 filoni di risposte
  • Devi essere connesso per rispondere a questo topic.

Go to top