diff --git a/web/documentation/css/jquery.tocify.css b/web/documentation/css/jquery.tocify.css old mode 100644 new mode 100755 diff --git a/web/documentation/img/bookmark_buttons.png b/web/documentation/img/bookmark_buttons.png new file mode 100644 index 00000000..4cc7b048 Binary files /dev/null and b/web/documentation/img/bookmark_buttons.png differ diff --git a/web/documentation/img/bookmark_creator.png b/web/documentation/img/bookmark_creator.png new file mode 100644 index 00000000..20551ce7 Binary files /dev/null and b/web/documentation/img/bookmark_creator.png differ diff --git a/web/documentation/img/bookmark_manager.png b/web/documentation/img/bookmark_manager.png new file mode 100644 index 00000000..8c5913ac Binary files /dev/null and b/web/documentation/img/bookmark_manager.png differ diff --git a/web/documentation/img/call_graph.png b/web/documentation/img/call_graph.png new file mode 100644 index 00000000..ac4d74d6 Binary files /dev/null and b/web/documentation/img/call_graph.png differ diff --git a/web/documentation/img/graph_view.png b/web/documentation/img/graph_view.png index 4a30725d..2419e8c0 100644 Binary files a/web/documentation/img/graph_view.png and b/web/documentation/img/graph_view.png differ diff --git a/web/documentation/img/main_window.png b/web/documentation/img/main_window.png index 368da33a..d78901b8 100644 Binary files a/web/documentation/img/main_window.png and b/web/documentation/img/main_window.png differ diff --git a/web/documentation/img/project_setup_wizard_java_maven.png b/web/documentation/img/project_setup_wizard_java_maven.png new file mode 100644 index 00000000..bf159713 Binary files /dev/null and b/web/documentation/img/project_setup_wizard_java_maven.png differ diff --git a/web/documentation/img/project_setup_wizard_start_java.png b/web/documentation/img/project_setup_wizard_start_java.png deleted file mode 100644 index 27d84886..00000000 Binary files a/web/documentation/img/project_setup_wizard_start_java.png and /dev/null differ diff --git a/web/documentation/img/project_setup_wizard_start_java_empty.png b/web/documentation/img/project_setup_wizard_start_java_empty.png new file mode 100644 index 00000000..72de4151 Binary files /dev/null and b/web/documentation/img/project_setup_wizard_start_java_empty.png differ diff --git a/web/documentation/img/project_setup_wizard_start_java_maven.png b/web/documentation/img/project_setup_wizard_start_java_maven.png new file mode 100644 index 00000000..5d1aa257 Binary files /dev/null and b/web/documentation/img/project_setup_wizard_start_java_maven.png differ diff --git a/web/documentation/img/search_view.png b/web/documentation/img/search_view.png index 15f737b5..80651160 100644 Binary files a/web/documentation/img/search_view.png and b/web/documentation/img/search_view.png differ diff --git a/web/documentation/index.html b/web/documentation/index.html index c284fbba..77be85a9 100644 --- a/web/documentation/index.html +++ b/web/documentation/index.html @@ -38,20 +38,18 @@ padding-top: 20px; } - #nav { - position:fixed; + .backlink { + position: fixed; width: 20%; margin-left: 2%; } .tocify { - position:static; - width: 100%; - margin-left: 0px; + margin-top: 30px; } @media (max-width: 767px) { - #nav { + .tocify { position: relative; width: 100%; } @@ -64,19 +62,11 @@
-
@@ -86,7 +76,7 @@
-

Documentation for version 0.11

+

Documentation for version 0.12

@@ -229,11 +219,23 @@

Project setup for Java

- Java projects can currently only be created as Empty Projects. Please follow the descriptions at Create an Empty Java Project. + + Are you using Maven? + +

If you are using Maven you can continue at Project creation from Maven to automatically setup your project using your Maven configuration.

- + +
+
+ + Create empty + If you do not have your project configured using Maven then please continue at Create an Empty Java Project and come back here as soon as the project is created. + +
+
+
@@ -421,7 +423,7 @@

Sourcetrail does two things with the data collected during indexing:

    -
  1. The data is stored in the .sourcetraildb file in the same directory as the .sourcetrailproject file. This database file is used by Sourcetrail to serve its purpose of letting you navigate your source code. And it allows Sourcetrail to reopen the project without reindexing the source code every time.
    2. +
  2. The data is stored in the .srctrldb file in the same directory as the .srctrlprj file. This database file is used by Sourcetrail to serve its purpose of letting you navigate your source code. And it allows Sourcetrail to reopen the project without reindexing the source code every time.
  3. If logging is enabled, some of the data gets logged into a log file saved in data/logs. These logs can be useful to us for fixing bugs. We might ask for log information on bug reports, but you should only provide it, if your source code is not confidental.
@@ -646,7 +648,11 @@ Indexer threads - Define how many parallel threads are used during indexing. + Define how many parallel threads are used during indexing. Setting this value to 0 will cause Sourcetrail to detect the number of available CPU cores and use as many threads for indexing. + + + Multi process C/C++ indexing + Enable C/C++ indexer threads to run in a different process. This prevents the application from crashing due to unforseen exceptions while indexing. Sourcetrail Port @@ -664,6 +670,10 @@ JVM Maximum Memory Specify the maximum amount of memory that should be allocated by the indexer's JVM. A value of -1 ignores this setting. + + Maven Path + Only required for indexing projects using Maven. Provide the location of your installed Maven executable. You can also use the auto detection. + Global Include Paths Set header search paths that are used for all of your projects (e.g. std headers). An option for automatic detection of these paths is available for Clang, GCC and the Visual Studio compiler. For instructions on how to add paths manually see Path List Box. For instructions on how to find the system header paths see Finding System Header Locations. @@ -708,7 +718,7 @@ Setting Description - Sourcetrail Project Name The name of the project. This will also be the name of the .sourcetrailproject file generated by Sourcetrail. + Sourcetrail Project Name The name of the project. This will also be the name of the .srctrlprj file generated by Sourcetrail. Sourcetrail Project Location Choose the location of the project file from the dialog. Standard Select the language standard that should be used for indexing your project. Usually the most recent language standard is preselected here. (See Language Support) @@ -852,7 +862,7 @@ Setting Description - Sourcetrail Project Name The name of the project. This will also be the name of the .sourcetrailproject file generated by Sourcetrail. + Sourcetrail Project Name The name of the project. This will also be the name of the .srctrlprj file generated by Sourcetrail. Sourcetrail Project Location Choose the location of the project file from the dialog. Compilation Database Select the compilation database .json for the project. Sourcetrail will index the project based on the compile commands in this file. If the compilation database changes you can Refresh Sourcetrail to the new files. @@ -879,12 +889,12 @@ Setting Description - Source Files Clicking show source files will show you a list of all source files in the compilation database. Indexed Header Paths Specify one or multiple locations that contain the header files to the source files defined in the compilation database. (For instructions on how to add paths see Path List Box.) Interactions: + +

Bookmarks

+ @@ -1438,15 +1557,27 @@ Cmd + 0 Ctrl + 0 + + Bookmark Active Symbol + Ctrl + D + Cmd + D + Ctrl + D + + + Bookmark Manager + Ctrl + B + Cmd + B + Ctrl + B +

Graph View

-

The graph view visualizes the currently selected symbol and all its relationships to other symbols as an interactive graph visualization.

+

The graph view visualizes the currently selected symbol and all its relationships to other symbols as an interactive graph visualization. You can also display whole call graphs, inheritance chains or include trees by using the toolbar in the top left. Read more about at Depth Graph.

-
+
@@ -1460,7 +1591,7 @@ Zooming: @@ -1518,6 +1649,22 @@
  • Hover an edge to see a tooltip that displays the edge’s type.
    • +

    Depth Graph

    +

    Using the toolbar in the top left you can display whole call graphs, inheritance chains or include trees for the currently active symbol if the right symbol type is currently active.

    +
    +
    + +
    +
    + Interactions: + +

    Code View

    @@ -1605,7 +1752,7 @@

    Back & Forward

    The left Backward button lets you undo your last navigation actions (see Back) and the right Forward button lets you redo your undone navigation actions again (see Forward). Both buttons are only enabled when the respective actions are available at the moment.

    -
    +
    @@ -1694,6 +1841,62 @@
  • Start a query with ?? to do a case-sensitive full text search.
    • +

    Bookmarking Buttons

    +

    The Bookmark Active Symbol button on the left opens the Bookmark Creator to create a new bookmark. The Bookmark Manager button on the right is used to display the Bookmark Manager for activating and editing your bookmarks.

    +
    +
    + +
    +
    + Interactions: +
      +
    • Hover the buttons to see a tool tip.
      • +
    • Press the buttons to execute the respective action.
      • +
    + +

    Bookmark Creator

    +

    Use the Bookmark Creator to create or edit bookmarks.

    +
    +
    + +
    +
    + + + + + + + + + +
    Setting Description
    Name The name of the bookmark. Initially the name of the node or edge is used.
    Comment Add an optional comment to the bookmark.
    Category Add the bookmark to a certain category. Bookmarks with the same category are grouped together in the Bookmark Manager.
    + Interactions: +
      +
    • Press Cancel to close without changes.
      • +
    • Press Create/Save to save the bookmark or apply the changes.
      • +
    + +

    Bookmark Manager

    +

    Use the Bookmark Manager to view and activate your bookmarks. Bookmarks are displayed as lines below their respective category. If a bookmark does not have a category it will be placed within the default category. The buttons for removing/editing categories or bookmarks are only visible when hovering the respective line. Bookmark information is stored within a separate .srctrlbm file next to your .srctrlprj project file.

    +
    +
    + +
    +
    + Interactions: +
      +
    • Activate bookmarks by clicking on the name.
      • +
    • Open/Collapse the bookmark comment by clicking within the bookmark line.
      • +
    • Click the Edit button to change the contents of the bookmark.
      • +
    • Click the Delete button at a bookmark to remove the bookmark.
      • +
    • Open/Collapse categories by clicking in their line.
      • +
    • Click the Delete button at a category to remove the category and all bookmarks within.
      • +
    • Change the Show filter to switch between display of nodes and/or edges.
      • +
    • Change the Sorting to change the order of bookmarks within their categories.
      • +
    + +

    Status View

    @@ -2135,7 +2338,7 @@ - +