sorry length of post. using doxygen 1.8.10 on w7 64 bit machine. have written , compiled code in code::blocks 13.12.
my file structure follows: d:/base/codeblocksprojects/sfml_apps/alarm clock contains cpp files , header files in /codeblocksprojects/include.
i want doxygen documentation saved in /codeblocksprojects/sfml_apps/alarm clock/doxygen. set working directory. output_directory set . (a single dot). means understand doxygen save it's generated files in /alarm clock/doxygen.
input set ../ should mean doxygen source files in /alarm clock/ folder. search_includes on , include path ../../../include. relative path generated when use directory finder button point include folder.
everything else pretty defaults. include files not being found , listed there no class information except few trivial classes in various test files in /alarm clock/ folder. have appended doxyfile settings.
any appreciated. have completed code , want document before moving on ...
# doxyfile 1.8.10 #--------------------------------------------------------------------------- # project related configuration options #--------------------------------------------------------------------------- doxyfile_encoding = utf-8 project_name = "alarm clock" project_number = "beta 1.01" project_brief = project_logo = output_directory = . create_subdirs = no allow_unicode_names = no output_language = english brief_member_desc = yes repeat_brief = yes abbreviate_brief = always_detailed_sec = no inline_inherited_memb = no full_path_names = no strip_from_path = strip_from_inc_path = short_names = no javadoc_autobrief = no qt_autobrief = no multiline_cpp_is_brief = no inherit_docs = yes separate_member_pages = no tab_size = 8 aliases = tcl_subst = optimize_output_for_c = no optimize_output_java = no optimize_for_fortran = no optimize_output_vhdl = no extension_mapping = markdown_support = yes autolink_support = yes builtin_stl_support = no cpp_cli_support = no sip_support = no idl_property_support = yes distribute_group_doc = no group_nested_compounds = no subgrouping = yes inline_grouped_classes = no inline_simple_structs = no typedef_hides_struct = no lookup_cache_size = 0 #--------------------------------------------------------------------------- # build related configuration options #--------------------------------------------------------------------------- extract_all = yes extract_private = yes extract_package = 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 = no hide_scope_names = no hide_compound_reference= no show_include_files = yes show_grouped_memb_inc = no force_local_includes = yes inline_info = yes sort_member_docs = yes sort_brief_docs = no sort_members_ctors_1st = no sort_group_names = no sort_by_scope_name = no strict_proto_matching = no generate_todolist = yes generate_testlist = yes generate_buglist = yes generate_deprecatedlist= yes enabled_sections = max_initializer_lines = 30 show_used_files = yes show_files = yes show_namespaces = yes file_version_filter = layout_file = cite_bib_files = #--------------------------------------------------------------------------- # configuration options related warning , progress messages #--------------------------------------------------------------------------- quiet = no warnings = yes warn_if_undocumented = no warn_if_doc_error = yes warn_no_paramdoc = yes warn_format = "$file:$line: $text" warn_logfile = "d:\coding\codeblocksprojects\sfml_apps\alarm clock\doxygen\doxygen.log" #--------------------------------------------------------------------------- # configuration options related input files #--------------------------------------------------------------------------- input = ../ input_encoding = utf-8 file_patterns = recursive = yes 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 filter_source_patterns = use_mdfile_as_mainpage = #--------------------------------------------------------------------------- # configuration options related source browsing #--------------------------------------------------------------------------- source_browser = yes inline_sources = yes strip_code_comments = yes referenced_by_relation = yes references_relation = yes references_link_source = yes source_tooltips = yes use_htags = no verbatim_headers = yes #--------------------------------------------------------------------------- # configuration options related alphabetical class index #--------------------------------------------------------------------------- alphabetical_index = yes cols_in_alpha_index = 5 ignore_prefix = #--------------------------------------------------------------------------- # configuration options related html output #--------------------------------------------------------------------------- generate_html = yes html_output = html html_file_extension = .html html_header = html_footer = html_stylesheet = html_extra_stylesheet = html_extra_files = html_colorstyle_hue = 220 html_colorstyle_sat = 100 html_colorstyle_gamma = 80 html_timestamp = yes html_dynamic_sections = no html_index_num_entries = 100 generate_docset = no docset_feedname = "doxygen generated docs" docset_bundle_id = org.doxygen.project docset_publisher_id = org.doxygen.publisher docset_publisher_name = publisher generate_htmlhelp = no chm_file = "../alarm clock.chm" hhc_location = generate_chi = no chm_index_encoding = binary_toc = no toc_expand = no generate_qhp = no qch_file = qhp_namespace = org.doxygen.project qhp_virtual_folder = doc qhp_cust_filter_name = qhp_cust_filter_attrs = qhp_sect_filter_attrs = qhg_location = generate_eclipsehelp = no eclipse_doc_id = org.doxygen.project disable_index = no generate_treeview = yes enum_values_per_line = 4 treeview_width = 250 ext_links_in_window = no formula_fontsize = 10 formula_transparent = yes use_mathjax = no mathjax_format = html-css mathjax_relpath = http://www.mathjax.org/mathjax mathjax_extensions = mathjax_codefile = searchengine = yes server_based_search = no external_search = no searchengine_url = searchdata_file = searchdata.xml external_search_id = extra_search_mappings = #--------------------------------------------------------------------------- # configuration options related latex output #--------------------------------------------------------------------------- generate_latex = no latex_output = latex latex_cmd_name = latex makeindex_cmd_name = makeindex compact_latex = no paper_type = a4 extra_packages = latex_header = latex_footer = latex_extra_stylesheet = latex_extra_files = pdf_hyperlinks = yes use_pdflatex = yes latex_batchmode = no latex_hide_indices = no latex_source_code = no latex_bib_style = plain #--------------------------------------------------------------------------- # configuration options related rtf output #--------------------------------------------------------------------------- generate_rtf = yes rtf_output = rtf compact_rtf = no rtf_hyperlinks = no rtf_stylesheet_file = rtf_extensions_file = rtf_source_code = no #--------------------------------------------------------------------------- # configuration options related man page output #--------------------------------------------------------------------------- generate_man = no man_output = man man_extension = .3 man_subdir = man_links = no #--------------------------------------------------------------------------- # configuration options related xml output #--------------------------------------------------------------------------- generate_xml = no xml_output = xml xml_programlisting = yes #--------------------------------------------------------------------------- # configuration options related docbook output #--------------------------------------------------------------------------- generate_docbook = no docbook_output = docbook docbook_programlisting = no #--------------------------------------------------------------------------- # configuration options autogen definitions output #--------------------------------------------------------------------------- generate_autogen_def = no #--------------------------------------------------------------------------- # configuration options related perl module output #--------------------------------------------------------------------------- generate_perlmod = no perlmod_latex = no perlmod_pretty = yes perlmod_makevar_prefix = #--------------------------------------------------------------------------- # configuration options related preprocessor #--------------------------------------------------------------------------- enable_preprocessing = yes macro_expansion = yes expand_only_predef = no search_includes = yes include_path = ../../../include include_file_patterns = predefined = expand_as_defined = skip_function_macros = no #--------------------------------------------------------------------------- # configuration options related external references #--------------------------------------------------------------------------- tagfiles = generate_tagfile = allexternals = no external_groups = yes external_pages = yes perl_path = /usr/bin/perl #--------------------------------------------------------------------------- # configuration options related dot tool #--------------------------------------------------------------------------- class_diagrams = yes mscgen_path = dia_path = hide_undoc_relations = yes have_dot = yes dot_num_threads = 0 dot_fontname = helvetica dot_fontsize = 10 dot_fontpath = class_graph = yes collaboration_graph = yes group_graphs = yes uml_look = no uml_limit_num_fields = 10 template_relations = no include_graph = yes included_by_graph = yes call_graph = yes caller_graph = yes graphical_hierarchy = yes directory_graph = yes dot_image_format = png interactive_svg = no dot_path = "c:\program files (x86)\graphviz2.38\bin\dot.exe" dotfile_dirs = mscfile_dirs = diafile_dirs = plantuml_jar_path = plantuml_include_path = dot_graph_max_nodes = 50 max_dot_graph_depth = 0 dot_transparent = no dot_multi_targets = no generate_legend = yes dot_cleanup = yes
i'm not sure how searching doxygen does, source files aren't in ../, they're in ../alarm clock. try explicitly specifying file directories:
input = "../alarm clock" ../../../include it space in directory name alarm clock causing problems (which why enclosed in quotes in input line).
edit
you need add doxygen style comments files want including in documentation. example:
/** * function document, notice double star in comment */ void func() alternatively add
extract_all = yes to config file. add docs functions (and thing try).
Comments
Post a Comment