Note that there are some explanatory texts on larger screens.

plurals
  1. PO
    primarykey
    data
    text
    <p>You can run <a href="http://en.wikipedia.org/wiki/Doxygen" rel="nofollow noreferrer">Doxygen</a> to generate an HTML-based source browser. This does not require that the code be annotated with Doxygen-style documentation. It works for multiple language, including <strong>C++</strong>, <strong>Java</strong>, and <strong>Markdown</strong> (<code>.md</code> files go to "Related Pages").</p> <p>Here's a way of configuring and launching Doxygen from the command-line (tested on Linux)...</p> <pre><code>## basic echo -e "SOURCE_BROWSER=YES\n EXTRACT_ALL=YES\n RECURSIVE=YES\n" |doxygen - xdg-open html/index.html </code></pre> <p>or</p> <pre><code>## include diagrams and non-public content -- and launch browser immediately echo -e "HAVE_DOT=YES\n CALL_GRAPH=YES\n CALLER_GRAPH=YES\n SOURCE_BROWSER=YES\n EXTRACT_ALL=YES\n EXTRACT_PRIVATE=YES\n EXTRACT_STATIC=YES\n RECURSIVE=YES\n SEPARATE_MEMBER_PAGES=YES\n GENERATE_LATEX=NO\n EXCLUDE_SYMLINKS=YES" |doxygen - &amp;&amp; chromium-browser --new-window html/index.html </code></pre> <p>There is a companion program called <strong><a href="http://www.stack.nl/~dimitri/doxygen/doxywizard_usage.html" rel="nofollow noreferrer">doxywizard</a></strong> which lets you browse through the many configuration options available for customizing the generated HTML. Alternatively, you can run <code>doxygen -g</code> to create an initial configuration file (which includes detailed hints).</p> <p>I recommend the following non-default options to generate a source browser:</p> <pre><code>SOURCE_BROWSER=YES ## display source code EXTRACT_ALL=YES ## display all items (not just "documented" ones) RECURSIVE=YES ## include source found in subdirectories SEPARATE_MEMBER_PAGES=YES ## optional -- each class member has its own page </code></pre> <p>Once you have the main web page up, you can browse to the source of interest (or use the search feature). The source is cross-referenced with clickable links to relevant declarations.</p> <hr> <p>I've run into this problem a few times: <em>doxygen can create really long filenames and Linux encrypted home directory has a <a href="https://askubuntu.com/q/728465/11522">limit of 143 characters</a></em>. To work around this, you may have to write the <code>html</code> folder outside of your home.</p> <p>A quick and dirty solution is to link <code>html</code> to a folder in <code>/tmp</code> or <code>/dev/shm</code> -- maybe also <code>chmod</code>ing the permissions for better data security.</p>
    singulars
    1. This table or related slice is empty.
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. VO
      singulars
      1. This table or related slice is empty.
    2. VO
      singulars
      1. This table or related slice is empty.
    3. VO
      singulars
      1. This table or related slice is empty.
 

Querying!

 
Guidance

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload