diff --git a/docs/documentation/img/project_setup_wizard_advanced_cxx.png b/docs/documentation/img/project_setup_wizard_advanced_cxx.png deleted file mode 100644 index c9d5ecdf..00000000 Binary files a/docs/documentation/img/project_setup_wizard_advanced_cxx.png and /dev/null differ diff --git a/docs/documentation/img/project_setup_wizard_advanced_cxx_cdb.png b/docs/documentation/img/project_setup_wizard_advanced_cxx_cdb.png deleted file mode 100644 index c1967ec5..00000000 Binary files a/docs/documentation/img/project_setup_wizard_advanced_cxx_cdb.png and /dev/null differ diff --git a/docs/documentation/img/project_setup_wizard_advanced_java.png b/docs/documentation/img/project_setup_wizard_advanced_java.png deleted file mode 100644 index 6f46d87f..00000000 Binary files a/docs/documentation/img/project_setup_wizard_advanced_java.png and /dev/null differ diff --git a/docs/documentation/img/project_setup_wizard_code_blocks.png b/docs/documentation/img/project_setup_wizard_code_blocks.png deleted file mode 100644 index b264ad84..00000000 Binary files a/docs/documentation/img/project_setup_wizard_code_blocks.png and /dev/null differ diff --git a/docs/documentation/img/project_setup_wizard_compilation_header.png b/docs/documentation/img/project_setup_wizard_compilation_header.png deleted file mode 100644 index 79529083..00000000 Binary files a/docs/documentation/img/project_setup_wizard_compilation_header.png and /dev/null differ diff --git a/docs/documentation/img/project_setup_wizard_custom_empty.png b/docs/documentation/img/project_setup_wizard_custom_empty.png deleted file mode 100644 index 46c23780..00000000 Binary files a/docs/documentation/img/project_setup_wizard_custom_empty.png and /dev/null differ diff --git a/docs/documentation/img/project_setup_wizard_dependencies_java.png b/docs/documentation/img/project_setup_wizard_dependencies_java.png deleted file mode 100644 index 84da77f5..00000000 Binary files a/docs/documentation/img/project_setup_wizard_dependencies_java.png and /dev/null differ diff --git a/docs/documentation/img/project_setup_wizard_empty_framework_paths.png b/docs/documentation/img/project_setup_wizard_empty_framework_paths.png deleted file mode 100644 index d7afd5b7..00000000 Binary files a/docs/documentation/img/project_setup_wizard_empty_framework_paths.png and /dev/null differ diff --git a/docs/documentation/img/project_setup_wizard_empty_include_paths.png b/docs/documentation/img/project_setup_wizard_empty_include_paths.png deleted file mode 100644 index b1a5633a..00000000 Binary files a/docs/documentation/img/project_setup_wizard_empty_include_paths.png and /dev/null differ diff --git a/docs/documentation/img/project_setup_wizard_empty_meta_java.png b/docs/documentation/img/project_setup_wizard_empty_meta_java.png deleted file mode 100644 index 885f8925..00000000 Binary files a/docs/documentation/img/project_setup_wizard_empty_meta_java.png and /dev/null differ diff --git a/docs/documentation/img/project_setup_wizard_empty_project_paths.png b/docs/documentation/img/project_setup_wizard_empty_project_paths.png deleted file mode 100644 index 8048db59..00000000 Binary files a/docs/documentation/img/project_setup_wizard_empty_project_paths.png and /dev/null differ diff --git a/docs/documentation/img/project_setup_wizard_empty_project_paths_java.png b/docs/documentation/img/project_setup_wizard_empty_project_paths_java.png deleted file mode 100644 index b7b0c5dd..00000000 Binary files a/docs/documentation/img/project_setup_wizard_empty_project_paths_java.png and /dev/null differ diff --git a/docs/documentation/img/project_setup_wizard_empty_project_paths_python.png b/docs/documentation/img/project_setup_wizard_empty_project_paths_python.png deleted file mode 100644 index 3b52e7a1..00000000 Binary files a/docs/documentation/img/project_setup_wizard_empty_project_paths_python.png and /dev/null differ diff --git a/docs/documentation/img/project_setup_wizard_empty_standard.png b/docs/documentation/img/project_setup_wizard_empty_standard.png deleted file mode 100644 index eec35eb6..00000000 Binary files a/docs/documentation/img/project_setup_wizard_empty_standard.png and /dev/null differ diff --git a/docs/documentation/img/project_setup_wizard_empty_standard_java.png b/docs/documentation/img/project_setup_wizard_empty_standard_java.png deleted file mode 100644 index 88f94a8d..00000000 Binary files a/docs/documentation/img/project_setup_wizard_empty_standard_java.png and /dev/null differ diff --git a/docs/documentation/img/project_setup_wizard_java_gradle.png b/docs/documentation/img/project_setup_wizard_java_gradle.png deleted file mode 100644 index 4fca44b6..00000000 Binary files a/docs/documentation/img/project_setup_wizard_java_gradle.png and /dev/null differ diff --git a/docs/documentation/img/project_setup_wizard_java_maven.png b/docs/documentation/img/project_setup_wizard_java_maven.png deleted file mode 100644 index 885f8925..00000000 Binary files a/docs/documentation/img/project_setup_wizard_java_maven.png and /dev/null differ diff --git a/docs/documentation/img/project_setup_wizard_sonar_graph.png b/docs/documentation/img/project_setup_wizard_sonar_graph.png deleted file mode 100644 index 7197d88d..00000000 Binary files a/docs/documentation/img/project_setup_wizard_sonar_graph.png and /dev/null differ diff --git a/docs/documentation/img/project_setup_wizard_sonar_graph_java.png b/docs/documentation/img/project_setup_wizard_sonar_graph_java.png deleted file mode 100644 index dbcebdaf..00000000 Binary files a/docs/documentation/img/project_setup_wizard_sonar_graph_java.png and /dev/null differ diff --git a/docs/documentation/img/project_setup_wizard_start_custom_empty.png b/docs/documentation/img/project_setup_wizard_start_custom_empty.png deleted file mode 100644 index 21855f77..00000000 Binary files a/docs/documentation/img/project_setup_wizard_start_custom_empty.png and /dev/null differ diff --git a/docs/documentation/img/project_setup_wizard_visual_studio.png b/docs/documentation/img/project_setup_wizard_visual_studio.png index 249e97ca..5f866317 100644 Binary files a/docs/documentation/img/project_setup_wizard_visual_studio.png and b/docs/documentation/img/project_setup_wizard_visual_studio.png differ diff --git a/docs/documentation/index.html b/docs/documentation/index.html index 424d5b14..177bf703 100644 --- a/docs/documentation/index.html +++ b/docs/documentation/index.html @@ -76,7 +76,7 @@
-

Documentation for version 2019.4

+

Documentation for version 2020.1

@@ -124,7 +124,7 @@

This short introduction will briefly guide you through the project setup and the user interface of Sourcetrail. The bullet point lists will provide you with the next steps to take:

Starting Up Sourcetrail

- +

Once you've downloaded Sourcetrail successfully you are ready to run the application. For assistance wth installation, visit the installation section.

@@ -152,7 +152,7 @@

Creating a New Project

- +

When creating a new Sourcetrail project you will use the Project Setup Wizard . This wizard splits the setup process into several subsequent steps. Depending on your project's structure and the used build system, there are different types for project setup. Choosing the correct setup method is important and can make the setup process a lot easier.

@@ -166,7 +166,7 @@
-
+

Add Source Group

@@ -193,11 +193,8 @@

Source Group Setup for C/C++

The Source Group setup types for C & C++ are the same.

-

This video gives you a detailed look into project setup for C++, including best practices and strategies on how to fix errors:

- - -
+
Are you using CMake, Make or Qt Creator?

If you are using CMake or Make as build environment you can export a clang JSON Compilaton Database as compile_commands.json file. A Compilation Database holds all information necessary for building the project, such as source files, include paths and compiler flags. Having a Compilation Database makes project setup within Sourcetrail a lot easier. We recommend using this approach if possible.

@@ -450,10 +447,10 @@

Installation

-

On Windows

+

Windows

Download and open the zip file and extract its contents into a temporary folder of your choice. Run the setup.exe and go through the wizard. You can now launch Sourcetrail from your start menu.

-

On Mac

+

macOS

Download and open the Sourcetrail.dmg file and drag Sourcetrail.app into the applications folder. You can now launch Sourcetrail from your Applications.

@@ -461,11 +458,17 @@
-

On Linux

-

Download Sourcetrail.tar.gz file and extract it. To start Sourcetrail run the Sourcetrail.sh script. Sourcetrail creates a folder ~/.config/sourcetrail at the first run, this is the folder for Sourcetrail settings.

+

Linux

+

Tarball

+

Download the .tar.gz file and extract it. To start Sourcetrail run the Sourcetrail.sh script. Sourcetrail creates a folder ~/.config/sourcetrail at the first run, this is the folder for Sourcetrail settings.

To Install Sourcetrail run the install.sh script with sudo, it will install Sourcetrail to /opt/sourcetrail and create /usr/bin/sourcetrail symlink.

+

AppImage

+

Download the .AppImage file. Give it permission to execute with chmod a+x or via the context menu. To start Sourcetrail double click it or execute it from the Terminal. Sourcetrail creates a folder ~/.config/sourcetrail at the first run, this is the folder for Sourcetrail settings.

+ +

For more information on AppImages please visit appimage.org.

+

Data folder

The data folder holds certain files that are used by Sourcetrail to run the program. After following the installation instructions the data folder should be located in the following locations on your platform.

@@ -474,26 +477,26 @@ - +
Windows C:/Users/You/AppData/Local/Coati Software/Sourcetrail (used for dynamic data and settings)
install_directory/Coati Software/Sourcetrail/data (used for static app data)
Mac ~/Library/Application Support/Sourcetrail
macOS ~/Library/Application Support/Sourcetrail
Linux ~/.config/sourcetrail

Finding System Header Locations

-

On Windows

+

Windows

These files usually ship with your compiler. For the Visual Studio IDE the system headers can be found at:

<path_to_visual_studio>/VC/include/

If you don't use the Visual Studio IDE you can also try to find your system headers in a subdirectory of:

C:/Program Files (x86)/Windows Kits/
-

On Mac

+

macOS

Run this command in your terminal:

gcc -x c++ -v -E /dev/null

You will find the header search paths your compiler uses in the output between these two lines:

#include <...> search starts here:
.
.
.
End of search list.
-

On Linux

+

Linux

gcc -x c++ -v -E /dev/null
or 
clang -x c++ -v -E /dev/null
@@ -505,11 +508,11 @@

The current version of Sourcetrail requires an installation of the Java 8 runtime environment to index any Java project. Make sure that Sourcetrail and your JRE share the same kind or architecture (a 32 bit Sourcetrail requires a 32 bit JRE). To locate the required library file, please refer to the applicable description below.

-

On Windows

+

Windows

The Java Runtime Library (called jvm.dll) can be found inside of your JRE install folder and looks like this:

<path_to_jre>/bin/client/jvm.dll
-

On Mac

+

macOS

The Java Runtime Library (called libjli.dylib) can be found inside of your JRE install folder. Run the following command in your terminal to find the location of your default Java installation:

/usr/libexec/java_home
@@ -521,7 +524,7 @@

Insert the full path to libjli.dylib into the Java Path setting in the Preferences Window.

-

On Linux

+

Linux

The Java Runtime Library (called libjvm.so) can be found inside of your JRE install folder and looks like this:

<path_to_jre>/lib/<arch>/server/libjvm.so
@@ -1190,11 +1193,19 @@

Shortcuts

+ +

General

- + + + + + + + @@ -1239,15 +1250,15 @@ - - - + + + - - - + + + @@ -1267,30 +1278,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - @@ -1354,6 +1341,138 @@
Shortcut Windows Mac OS X Linux
Shortcut Windows macOS Linux
Switch Focus Between Graph/Code ViewsTabTabTab
Preferences Ctrl + ,
BackCtrl + Z / BackspaceCmd + Z / BackspaceCtrl + Z / BackspaceZ / Alt + Left / BackspaceZ / Cmd + [ / BackspaceZ / Alt + Left / Backspace
ForwardCtrl + Shift + ZCmd + Shift + ZCtrl + Shift + ZShift + Z / Alt + RightShift + Z / Cmd + ]Shift + Z / Alt + Right
Find SymbolCmd + D Ctrl + D
Next ReferenceCtrl + GCmd + GCtrl + G
Previous ReferenceCtrl + Shift + GCmd + Shift + GCtrl + Shift + G
Next Local ReferenceCtrl + TCmd + TCtrl + T
Previous Local ReferenceCtrl + Shift + TCmd + Shift + TCtrl + Shift + T
To overview Ctrl + Home
+

Graph View

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Shortcut Windows macOS Linux
Move Focus Within NodesWASD / HJKL / ArrowsWASD / HJKL / ArrowsWASD / HJKL / Arrows
Move Focus Within EdgesShift + WASD / Shift + HJKL / Shift + ArrowsShift + WASD / Shift + HJKL / Shift + ArrowsShift + WASD / Shift + HJKL / Shift + Arrows
Activate Node/EdgeEnter / EEnter / EEnter / E
Activate Node in New TabCtrl + Shift + Enter / Ctrl + Shift + ECmd + Shift + Enter / Cmd + Shift + ECtrl + Shift + Enter / Ctrl + Shift + E
Expand/Collapse NodeShift + Enter / Shift + EShift + Enter / Shift + EShift + Enter / Shift + E
PanCtrl + ArrowsCmd + ArrowsCtrl + Arrows
Zoom InCtrl + Shift + Up / Ctrl + Mouse Wheel UpCmd + Shift + Up / Cmd + Mouse Wheel UpCtrl + Shift + Up / Ctrl + Mouse Wheel Up
Zoom OutCtrl + Shift + Down / Ctrl + Mouse Wheel DownCmd + Shift + Down / Cmd + Mouse Wheel DownCtrl + Shift + Down / Ctrl + Mouse Wheel Down
Reset Zoom000
Open Custom Trail DialogCtrl + UCmd + UCtrl + U
+ +

Code View

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Shortcut Windows macOS Linux
Next ReferenceCtrl + GCmd + GCtrl + G
Previous ReferenceCtrl + Shift + GCmd + Shift + GCtrl + Shift + G
Next Local ReferenceCtrl + TCmd + TCtrl + T
Previous Local ReferenceCtrl + Shift + TCmd + Shift + TCtrl + Shift + T
Move Focus Within CodeWASD / HJKL / ArrowsWASD / HJKL / ArrowsWASD / HJKL / Arrows
Move Focus to Closest ReferenceShift + WASD / Shift + HJKL / Shift + ArrowsShift + WASD / Shift + HJKL / Shift + ArrowsShift + WASD / Shift + HJKL / Shift + Arrows
Activate LocationEnter / EEnter / EEnter / E
Activate Location in New TabCtrl + Shift + Enter / Ctrl + Shift + ECmd + Shift + Enter / Cmd + Shift + ECtrl + Shift + Enter / Ctrl + Shift + E
ScrollCtrl + ArrowsCmd + ArrowsCtrl + Arrows
+

Graph View

@@ -1938,7 +2057,7 @@
-

Choose a Source Group type

+

Choose a Source Group Type

When creating a new Source Group you can choose between different methods of setup depending on your project language. Please have a look at our QUCICK START GUIDE section for help on choosing the right Source Group type.

@@ -1959,49 +2078,29 @@
-

Create an Empty C/C++ Source Group

-

This is the way to go if you just have some C/C++ source files you want to index. In case you have a build instructions file, you might want to check out one of the other options for Source Group setup described below.

+

Empty C/C++ Source Group

+

Empty C/C++ Source Groups have the following configuration options:

- Language Standard -

In the first step you need to choose the desired language standard. Optionally you can also specify a target platform if your project usually would be cross-compiled for a platform that is different from the one Sourcetrail is used on.

-
-
- -
-
- - - -
Setting Description
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)
Cross-compilation Check Use specific target and then use the dropdown boxes to specify a certain target platform. Please have a look at the clang compiler documentation on cross-compilation for more information.
- Interactions: - - -
- -

Indexed Paths

-

Provide the paths that contain your source files you want to index. Sourcetrail will index all the source and header files in the specified paths, including subdirectories.

-
-
- -
-
- - - - - - - + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Setting Description
Files & Directories to Index

These paths define the files and directories that will be indexed by Sourcetrail. Provide a directory to recursively add all contained source and header files. If your project's source code resides in one location, but generated source files are kept at a different location, you will also need to add that directory. You can make use of environment variables with ${ENV_VAR}.

For instructions on how to add paths see Path List Box.
Excluded Files & Directories -

These paths define the files and directories that will be left out from indexing.

+
StandardSelect the language standard that should be used for indexing your project. Usually the most recent language standard is preselected here. (See Language Support)
Cross-compilationCheck Use specific target and then use the dropdown boxes to specify a certain target platform. Please have a look at the clang compiler documentation on cross-compilation for more information.
Files & Directories to Index

These paths define the files and directories that will be indexed by Sourcetrail. Provide a directory to recursively add all contained source and header files. If your project's source code resides in one location, but generated source files are kept at a different location, you will also need to add that directory. You can make use of environment variables with ${ENV_VAR}.

For instructions on how to add paths see Path List Box.

Excluded Files & Directories

These paths define the files and directories that will be left out from indexing.

Hints:

  • You can use the wildcard * which represents characters except \ or / (e.g. src/*/test.h matches src/app/test.h but does not match src/app/widget/test.h or src/test.h)
    • @@ -2010,129 +2109,65 @@

For instructions on how to add paths see Path List Box.
Source File Extensions Define the valid extensions for source files including the dot e.g. .cpp. Sourcetrail will only try to index files that match one of these extensions.
Source File ExtensionsDefine the valid extensions for source files including the dot e.g. .cpp. Sourcetrail will only try to index files that match one of these extensions.
Include Paths

Include Paths are used for resolving #include directives in the indexed source and header files. These paths are usually passed to the compiler with the '-I' or '-iquote' flags. Add all paths #include directives throughout your project are relative to. If all #include directives are specified relative to the project's root directory, please add that root directory here. If your project also includes files from external libraries (e.g. boost), please add these directories as well (e.g. add 'path/to/boost_home/include'). You can make use of environment variables with ${ENV_VAR}.

For instructions on how to add paths see Path List Box.

Global Include Paths

The Global Include Paths will be used in all your projects in addition to the project specific Include Paths. These paths are usually passed to the compiler with the '-isystem' flag. Use them to add system header paths (See Finding System Header Locations or use the auto detection below).

For instructions on how to add paths see Path List Box.

Framework Search Paths (macOS only)These paths are used to find .framework files used by your project. (For instructions on how to add paths see Path List Box.)
Global Framework Search Paths (macOS only)These Framework Search Paths will be used in all your projects. (For instructions on how to add paths see Path List Box. For instructions on how to find the system header paths see Finding System Header Locations)
Compiler Flags

Define additional compiler flags used during indexing including the dash (e.g. use -D RELEASE to add a #define for RELEASE).

For instructions on how to add paths see Path List Box.

Precompiled Header File

Select the path to the header file that should be used to generate a Precompiled Header File. The Precompiled Header File will be generated as pre-indexing step. If no path is supplied, no Precompiled Header File will be generated.

Precompiled Header Flags

Define if the already supplied compiler flags should be used for Precompiled Header File generation and define additional flags for Precompiled Header File generation only.

For instructions on how to add paths see Path List Box.
- Interactions: -
-

Include Paths

-

Sourcetrail needs you to specify all the include paths the indexed source and header files rely on. The include paths are those paths your project's #include directives are relative to. If your project requires additional includes to compile (e.g. Boost for C++, etc.), please specify their location here.

-

Additionally you can also specify Global Include Paths, which will be used by all your projects. These are usually the paths to system headers, which can also be auto detected by choosing a compiler below and pressing detect.

-
-
- -
-
- - - - - - - - -
Setting Description
Include Paths

Include Paths are used for resolving #include directives in the indexed source and header files. These paths are usually passed to the compiler with the '-I' or '-iquote' flags. Add all paths #include directives throughout your project are relative to. If all #include directives are specified relative to the project's root directory, please add that root directory here. If your project also includes files from external libraries (e.g. boost), please add these directories as well (e.g. add 'path/to/boost_home/include'). You can make use of environment variables with ${ENV_VAR}.

For instructions on how to add paths see Path List Box.
Global Include Paths

The Global Include Paths will be used in all your projects in addition to the project specific Include Paths. These paths are usually passed to the compiler with the '-isystem' flag. Use them to add system header paths (See Finding System Header Locations or use the auto detection below).

For instructions on how to add paths see Path List Box.
- Interactions: - +

C/C++ Source Group from Compilation Database

-
- -

Framework Search Paths (macOS only)

-

Sourcetrail needs you to specify the locations of .framework files, your indexed source and header files rely on.

-

Additionally you can also specify Global Framework Search Paths, which will be used by all your projects. They can also be auto detected by choosing a compiler below and pressing detect.

-
-
- -
-
- - - - - - - - -
Setting Description
Framework Search Paths These paths are used to find .framework files used by your project. (For instructions on how to add paths see Path List Box.)
Global Framework Search Paths These Framework Search Paths will be used in all your projects. (For instructions on how to add paths see Path List Box. For instructions on how to find the system header paths see Finding System Header Locations)
- Interactions: - - -
- -

Advanced Settings

-

In this dialog you can enter additional settings.

-
-
- -
-
- - - - - - - - - -
Setting Description
Compiler Flags

Define additional compiler flags used during indexing including the dash (e.g. use -D RELEASE to add a #define for RELEASE).

For instructions on how to add paths see Path List Box.
Precompiled Header File

Select the path to the header file that should be used to generate a Precompiled Header File. The Precompiled Header File will be generated as pre-indexing step. If no path is supplied, no Precompiled Header File will be generated.
Precompiled Header Flags

Define if the already supplied compiler flags should be used for Precompiled Header File generation and define additional flags for Precompiled Header File generation only.

For instructions on how to add paths see Path List Box.
- Interactions: - - -
-

After this step you will return to the Project Setup Wizard.

-
- -
- - -

Create a C/C++ Source Group from Compilation Database

If you are using CMake you can export compile commands by defining the CMAKE_EXPORT_COMPILE_COMMANDS flag and then use the exportet .json file for Sourcetrail project setup.

For non-CMake projects you can use Bear. Bear generates a .json file during the simulated build process. Bear has been tested on FreeBSD, GNU/Linux and OS X.

+

C/C++ Source Groups from Compilation Database offer the following configuration options:

-
- -

Compilation Database file and Indexed Headers

-

In the first step you need to enter the path to your Compilation Database file. Then you can see which source files have been found in the Compilation Database and define the locations of the corresponding header files.

-

Header files will only be indexed if they are included in one of the source files.

-
-
- -
-
- - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Setting Description
Compilation Database Select the compilation database file for the project. Sourcetrail will index your project based on the compile commands this file contains using all include paths and compiler flags of these compile commands. The project will stay up to date with changes in the compilation database on every refresh. You can make use of environment variables with ${ENV_VAR}.
Header Files & Directories to Index

Your Compilation Database already specifies which source files are part of your project. But Sourcetrail still needs to know which header files to index as part of your project and which to skip. Choosing to skip indexing your system headers or external frameworks will significantly improve the overall indexing performance. Use this list to define which header files should be indexed by Sourcetrail. Provide a directory to recursively add all contained files. You can make use of environment variables with ${ENV_VAR}.

Hint: Just enter the root path of your project if you want Sourcetrail to index all contained headers it encounters.

For instructions on how to add paths see Path List Box.
Excluded Files & Directories -

These paths define the files and directories that will be left out from indexing.

+
Compilation DatabaseSelect the compilation database file for the project. Sourcetrail will index your project based on the compile commands this file contains using all include paths and compiler flags of these compile commands. The project will stay up to date with changes in the compilation database on every refresh. You can make use of environment variables with ${ENV_VAR}.
Header Files & Directories to Index

Your Compilation Database already specifies which source files are part of your project. But Sourcetrail still needs to know which header files to index as part of your project and which to skip. Choosing to skip indexing your system headers or external frameworks will significantly improve the overall indexing performance. Use this list to define which header files should be indexed by Sourcetrail. Provide a directory to recursively add all contained files. You can make use of environment variables with ${ENV_VAR}.

Hint: Just enter the root path of your project if you want Sourcetrail to index all contained headers it encounters.

For instructions on how to add paths see Path List Box.

Excluded Files & Directories

These paths define the files and directories that will be left out from indexing.

Hints:

  • You can use the wildcard * which represents characters except \ or / (e.g. src/*/test.h matches src/app/test.h but does not match src/app/widget/test.h or src/test.h)
    • @@ -2141,50 +2176,40 @@

For instructions on how to add paths see Path List Box.
Additional Include Paths

Include Paths are used for resolving #include directives in the indexed source and header files. These paths are usually passed to the compiler with the '-I' or '-iquote' flags. Add all paths #include directives throughout your project are relative to. If all #include directives are specified relative to the project's root directory, please add that root directory here. If your project also includes files from external libraries (e.g. boost), please add these directories as well (e.g. add 'path/to/boost_home/include'). You can make use of environment variables with ${ENV_VAR}.

For instructions on how to add paths see Path List Box.

Global Include Paths

The Global Include Paths will be used in all your projects in addition to the project specific Include Paths. These paths are usually passed to the compiler with the '-isystem' flag. Use them to add system header paths (See Finding System Header Locations or use the auto detection below).

For instructions on how to add paths see Path List Box.

Framework Search Paths (macOS only)These paths are used to find .framework files used by your project. (For instructions on how to add paths see Path List Box.)
Global Framework Search Paths (macOS only)These Framework Search Paths will be used in all your projects. (For instructions on how to add paths see Path List Box. For instructions on how to find the system header paths see Finding System Header Locations)
Additional Compiler Flags

Define additional compiler flags used during indexing including the dash (e.g. use -D RELEASE to add a #define for RELEASE).

For instructions on how to add paths see Path List Box.

Precompiled Header File

Select the path to the header file that should be used to generate a Precompiled Header File. The Precompiled Header File will be generated as pre-indexing step. If no path is supplied, no Precompiled Header File will be generated.

Precompiled Header Flags

Define if the already supplied compiler flags should be used for Precompiled Header File generation and define additional flags for Precompiled Header File generation only.

For instructions on how to add paths see Path List Box.
- Interactions: -
-

Advanced Settings

-

In this dialog you can enter additional settings.

-
-
- -
-
- - - - - - - - -
Setting Description
Precompiled Header File

Select the path to the header file that should be used to generate a Precompiled Header File. The Precompiled Header File will be generated as pre-indexing step. If no path is supplied, no Precompiled Header File will be generated.
Precompiled Header Flags

Define if the compiler flags of the first compile command that is using a Precompiled Header File should be used for Precompiled Header File generation and define additional flags for Precompiled Header File generation only.

For instructions on how to add paths see Path List Box.
- Interactions: - - -
-

After this step you will return to the Project Setup Wizard.

-
- -
- - -

Create a C/C++ Source Group from Visual Studio Solution

+

C/C++ Source Group from Visual Studio

If you are using Visual Studio you can export a Compilation Database with our Visual Studio Plugin and use it to create a project with Sourcetrail.

@@ -2204,29 +2229,34 @@
-

Create a C/C++ Source Group from Code::Blocks Project

+

C/C++ Source Group from Code::Blocks

If you already have a working Code::Blocks project (.cbp) for your source code you can use it to create a project with Sourcetrail. Note that a .cbp file will be generated by the QtCreator if a CMakeLists file is imported. -

+

C/C++ Source Groups from Code::Blocks offer the following configuration options:

-

Code::Blocks Project Path

-

In this step you need to enter the path to your Code::Blocks Project file and specify some additional options. Then you can see which source files have been found in the Code::Blocks Project and define the locations of the corresponding header files that should be indexed.

-

Note that header files will only be indexed if they are included in one of the source files.

-
-
- -
-
- - - - - + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + +
Setting Description
C++ Standard Select the language standard that should be used for indexing your project's C++ files. Usually the most recent language standard is preselected here. (See Language Support)
C Standard Select the language standard that should be used for indexing your project's C files. Usually the most recent language standard is preselected here. (See Language Support)
Code::Blocks Project Select the .cbp file for the project. Sourcetrail will index your project based on the settings specified by the Code::Blocks project file. Your Sourcetrail project will stay up to date with changes in the Code::Blocks project file on every refresh. You can make use of environment variables with ${ENV_VAR}.
Header Files & Directories to Index

Your Code::Blocks project already specifies which source files are part of your project. But Sourcetrail still needs to know which header files to index as part of your project and which to skip. Choosing to skip indexing your system headers or external frameworks will significantly improve the overall indexing performance. Use this list to define which header files should be indexed by Sourcetrail. Provide a directory to recursively add all contained files. You can make use of environment variables with ${ENV_VAR}.

Hint: Just enter the root path of your project if you want Sourcetrail to index all contained headers it encounters.

For instructions on how to add paths see Path List Box.
Excluded Files & Directories -

These paths define the files and directories that will be left out from indexing.

+
C++ StandardSelect the language standard that should be used for indexing your project's C++ files. Usually the most recent language standard is preselected here. (See Language Support)
C StandardSelect the language standard that should be used for indexing your project's C files. Usually the most recent language standard is preselected here. (See Language Support)
Code::Blocks ProjectSelect the .cbp file for the project. Sourcetrail will index your project based on the settings specified by the Code::Blocks project file. Your Sourcetrail project will stay up to date with changes in the Code::Blocks project file on every refresh. You can make use of environment variables with ${ENV_VAR}.
Header Files & Directories to Index

Your Code::Blocks project already specifies which source files are part of your project. But Sourcetrail still needs to know which header files to index as part of your project and which to skip. Choosing to skip indexing your system headers or external frameworks will significantly improve the overall indexing performance. Use this list to define which header files should be indexed by Sourcetrail. Provide a directory to recursively add all contained files. You can make use of environment variables with ${ENV_VAR}.

Hint: Just enter the root path of your project if you want Sourcetrail to index all contained headers it encounters.

For instructions on how to add paths see Path List Box.

Excluded Files & Directories

These paths define the files and directories that will be left out from indexing.

Hints:

  • You can use the wildcard * which represents characters except \ or / (e.g. src/*/test.h matches src/app/test.h but does not match src/app/widget/test.h or src/test.h)
    • @@ -2235,108 +2265,56 @@

For instructions on how to add paths see Path List Box.
Source File Extensions Define the valid extensions for source files including the dot e.g. .cpp. Sourcetrail will only try to index files that match one of these extensions.
Source File ExtensionsDefine the valid extensions for source files including the dot e.g. .cpp. Sourcetrail will only try to index files that match one of these extensions.
Additional Include Paths

Include Paths are used for resolving #include directives in the indexed source and header files. These paths are usually passed to the compiler with the '-I' or '-iquote' flags. Add all paths #include directives throughout your project are relative to. If all #include directives are specified relative to the project's root directory, please add that root directory here. If your project also includes files from external libraries (e.g. boost), please add these directories as well (e.g. add 'path/to/boost_home/include'). You can make use of environment variables with ${ENV_VAR}.

For instructions on how to add paths see Path List Box.

Global Include Paths

The Global Include Paths will be used in all your projects in addition to the project specific Include Paths. These paths are usually passed to the compiler with the '-isystem' flag. Use them to add system header paths (See Finding System Header Locations or use the auto detection below).

For instructions on how to add paths see Path List Box.

Framework Search Paths (macOS only)These paths are used to find .framework files used by your project. (For instructions on how to add paths see Path List Box.)
Global Framework Search Paths (macOS only)These Framework Search Paths will be used in all your projects. (For instructions on how to add paths see Path List Box. For instructions on how to find the system header paths see Finding System Header Locations)
Additional Compiler Flags

Define additional compiler flags used during indexing including the dash (e.g. use -D RELEASE to add a #define for RELEASE).

For instructions on how to add paths see Path List Box.
- Interactions: -
    -
  • Clicking show source files will show you a list of all source files that will be indexed by Sourcetrail.
    • -
  • Clicking Select From Code::Blocks Project will display a dialog showing a list of all the Include Paths used within the Code::Blocks project. You can select paths here, so that all headers that are included within these paths will also get indexed.
    • -
  • Clicking Cancel or pressing ESC will close the window and abort the setup process.
    • -
  • Clicking Next will take you to the next step of the setup process.
    • -
  • Clicking Previous will take you to the previous step of the setup process.
    • -
- -
-

After this step you will return to the Project Setup Wizard.

-
-

Create a C/C++ Source Group from Sonargraph Project

-

If you already have a working Sonargraph project setup for your code you can use it to create a project with Sourcetrail. Currently Sourcetrail supports manual and CMake JSON C/C++ Sonargraph modules.

- -
- -

Sonargraph Project Path

-

In this step you need to enter the path to your Sonargraph Project file and specify some additional options. Then you can see which source files have been found in the Sonargraph Project and define the locations of the corresponding header files that should be indexed.

-

Note that header files will only be indexed if they are included in one of the source files.

-
-
- -
-
- - - - - - - - - -
Setting Description
C++ 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)
Sonargraph Project Select the system.sonargraph file for the project. Sourcetrail will index your project based on the settings specified by the Sonargraph file. Your Sourcetrail project will stay up to date with changes in the Sonargraph project file on every refresh. You can make use of environment variables with ${ENV_VAR}.
Header Files & Directories to Index

Your Sonargraph project already specifies which source files are part of your project. But Sourcetrail still needs to know which header files to index as part of your project and which to skip. Choosing to skip indexing your system headers or external frameworks will significantly improve the overall indexing performance. Use this list to define which header files should be indexed by Sourcetrail. Provide a directory to recursively add all contained files. You can make use of environment variables with ${ENV_VAR}.

Hint: Just enter the root path of your project if you want Sourcetrail to index all contained headers it encounters.

For instructions on how to add paths see Path List Box.
- Interactions: -
    -
  • Clicking show source files will show you a list of all source files that will be indexed by Sourcetrail.
    • -
  • Clicking Select From Sonargraph Project will display a dialog showing a list of all the Include Paths used within the Sonargraph project. You can select paths here, so that all headers that are included within these paths will also get indexed.
    • -
  • Clicking Cancel or pressing ESC will close the window and abort the setup process.
    • -
  • Clicking Next will take you to the next step of the setup process.
    • -
  • Clicking Previous will take you to the previous step of the setup process.
    • -
- -
-

After this step you will return to the Project Setup Wizard.

-
- -
- - -

Create an Empty Java Source Group

+

Empty Java Source Group

Choose this option if you want to index Java files using Sourcetrail.

+

Empty Java Source Groups offer the following configuration options:

- Language Standard -

In the first step you need to set the Java standard for the source files.

-
-
- -
-
- + - - -
Setting Description
Setting Description
Standard Select the language standard that should be used for indexing your the Source Group. Usually the most recent language standard is preselected here. (See Language Support)
- Interactions: -
    -
  • Clicking Cancel or pressing ESC will close the window and abort the setup process.
    • -
  • Clicking Next will take you to the next step of the setup process.
    • -
  • Clicking Previous will take you to the previous step of the setup process. All the information you entered will be saved.
    • -
- -
- -

Indexed Paths

-

In this step you provide all the information Sourcetrail needs to know about your code base.

- -
-
- -
-
- - - - - - - - + + + + + + + + + + - + + + + + + + + + + +
Setting Description
Files & Directories to Index

These paths define the files and directories that will be indexed by Sourcetrail. Provide a directory to recursively add all contained source and header files. If your project's source code resides in one location, but generated source files are kept at a different location, you will also need to add that directory. You can make use of environment variables with ${ENV_VAR}.

For instructions on how to add paths see Path List Box.
Excluded Files & Directories -

These paths define the files and directories that will be left out from indexing.

+
StandardSelect the language standard that should be used for indexing your the Source Group. Usually the most recent language standard is preselected here. (See Language Support)
Files & Directories to Index

These paths define the files and directories that will be indexed by Sourcetrail. Provide a directory to recursively add all contained source and header files. If your project's source code resides in one location, but generated source files are kept at a different location, you will also need to add that directory. You can make use of environment variables with ${ENV_VAR}.

For instructions on how to add paths see Path List Box.

Excluded Files & Directories

These paths define the files and directories that will be left out from indexing.

Hints:

  • You can use the wildcard * which represents characters except \ or / (e.g. src/*/test.java matches src/app/test.java but does not match src/app/widget/test.java or src/test.java)
    • @@ -2345,86 +2323,50 @@

For instructions on how to add paths see Path List Box.
Source File Extensions Define the valid extensions for source files including the dot e.g. .java. Sourcetrail will only try to index files that match one of these extensions.
Source File ExtensionsDefine the valid extensions for source files including the dot e.g. .java. Sourcetrail will only try to index files that match one of these extensions.
Class Path Enter all the .jar files your project depends on. If your project depends on uncompiled java code that should not be indexed, please add the root directory of those .java files here (the one where all the package names are relative to). You can make use of environment variables with ${ENV_VAR}.
JRE System LibraryTick this box to use the JRE System library jars specified in your application settings. Disable this setting if you want to use another JRE System library for this project and add the respective jars to the project's Class Path.
-

Dependencies

-

In this dialog you can specify all the dependencies your project uses.

-
-
- -
-
- - - - - - - - -
Setting Description
Class Path Enter all the .jar files your project depends on. If your project depends on uncompiled java code that should not be indexed, please add the root directory of those .java files here (the one where all the package names are relative to). You can make use of environment variables with ${ENV_VAR}.
JRE System Library Tick this box to use the JRE System library jars specified in your application settings. Disable this setting if you want to use another JRE System library for this project and add the respective jars to the project's Class Path.
- Interactions: -
    -
  • Clicking Cancel or pressing ESC will close the window and abort the setup process.
    • -
  • Clicking Next will take you to the next step of the setup process.
    • -
  • Clicking Previous will take you to the previous step of the setup process. All the information you entered will be saved.
    • -
- -
-

After this step you will return to the Project Setup Wizard.

-
- -
- - -

Create a Java Source Group from your Gradle Configuration

+

Java Source Group from Gradle

If you are using a Gradle configuration to manage and build your project use this approach to create a Sourcetrail Source Group.

+

Java Source Groups from Gradle offer the following configuration options:

-

Gradle Project Indexed Paths

-

In the first step you need to choose your project's Gradle build.gradle file and select a directory where the dependencies get stored.

-
-
- -
-
- - - - -
Setting Description
Gradle Project File The path to the build.gradle file in the root folder of your Gradle project.
Should Index Tests This checkbox indicates whether or not Sourcetrail indexes the test code that is part of your Gradle project.
Intermediate Dependencies Directory Directory where Sourcetrail stores all of the project's .jar dependencies.
- Interactions: -
    -
  • Clicking show source files will show you a list of all source files that have been detected in the Gradle project. If Should Index Tests is checked this list also includes the test source files.
    • -
  • Clicking Cancel or pressing ESC will close the window and abort the setup process.
    • -
  • Clicking Next will take you to the next step of the setup process.
    • -
  • Clicking Previous will take you to the previous step of the setup process.
    • -
- -
- -

Advanced Settings Java

-

In this dialog you can enter additional settings. You can define source file extentions and you can exclude certain paths or files from indexing.

-
-
- -
-
- - - - - - + + + + + + + + + + + + + + + + + + - + + + +
Setting Description
Excluded Files & Directories -

These paths define the files and directories that will be left out from indexing.

+
StandardSelect the language standard that should be used for indexing your the Source Group. Usually the most recent language standard is preselected here. (See Language Support)
Gradle Project File The path to the build.gradle file in the root folder of your Gradle project.
Should Index Tests This checkbox indicates whether or not Sourcetrail indexes the test code that is part of your Gradle project.
Intermediate Dependencies DirectoryDirectory where Sourcetrail stores all of the project's .jar dependencies.
Excluded Files & Directories

These paths define the files and directories that will be left out from indexing.

Hints:

  • You can use the wildcard * which represents characters except \ or / (e.g. src/*/test.java matches src/app/test.java but does not match src/app/widget/test.java or src/test.java)
    • @@ -2433,130 +2375,64 @@

For instructions on how to add paths see Path List Box.
Source File Extensions Define the valid extensions for source files including the dot e.g. .java. Sourcetrail will only try to index files that match one of these extensions.
Source File ExtensionsDefine the valid extensions for source files including the dot e.g. .java. Sourcetrail will only try to index files that match one of these extensions.
- Interactions: -
    -
  • Clicking Cancel or pressing ESC will close the window and abort the setup process.
    • -
  • Clicking Next will take you to the next step of the setup process.
    • -
  • Clicking Previous will take you to the previous step of the setup process. All the information you entered will be saved.
    • -
-
-

After this step you will return to the Project Setup Wizard.

-
+
-
- - -

Create a Java Source Group from your Maven Configuration

+

Java Source Group from Maven

If you are using a Maven configuration to manage and build your project use this approach to create a Sourcetrail Source Group.

+

Java Source Groups from Maven offer the following configuration options:

-

Maven Project Indexed Paths

-

In the first step you need to choose your Maven pom.xml file and select a directory where the dependencies get stored.

-
-
- -
-
- - - + + + + + + + + + + + + + + + + + + + + + + + +
Setting Description
Maven Project File The path to the pom.xml file in the root folder of your Maven project.
Should Index Tests This checkbox indicates whether or not Sourcetrail indexes the test code that is part of your Maven project.
Intermediate Dependencies Directory Directory where Sourcetrail stores all of the project's .jar dependencies.
StandardSelect the language standard that should be used for indexing your the Source Group. Usually the most recent language standard is preselected here. (See Language Support)
Maven Project File The path to the pom.xml file in the root folder of your Maven project.
Should Index Tests This checkbox indicates whether or not Sourcetrail indexes the test code that is part of your Maven project.
Intermediate Dependencies DirectoryDirectory where Sourcetrail stores all of the project's .jar dependencies.
Excluded Files & Directories

These paths define the files and directories that will be left out from indexing.

+

Hints:

+
    +
  • You can use the wildcard * which represents characters except \ or / (e.g. src/*/test.java matches src/app/test.java but does not match src/app/widget/test.java or src/test.java)
    • +
  • You can use the wildcard ** which represents arbitrary characters (e.g. src**test.java matches src/app/test.java as well as src/app/widget/test.java or src/test.java)
    • +
  • You can make use of environment variables with ${ENV_VAR}
    • +
+

For instructions on how to add paths see Path List Box.

Source File ExtensionsDefine the valid extensions for source files including the dot e.g. .java. Sourcetrail will only try to index files that match one of these extensions.
- Interactions: -
    -
  • Clicking show source files will show you a list of all source files that have been detected in the Maven project. If Should Index Tests is checked this list also includes the test source files.
    • -
  • Clicking Cancel or pressing ESC will close the window and abort the setup process.
    • -
  • Clicking Next will take you to the next step of the setup process.
    • -
  • Clicking Previous will take you to the previous step of the setup process.
    • -
- -
-

After this step you will continue at the Advanced Settings Java.

-
- -
- - -

Create a Java Source Group from Sonargraph Project

-

If you already have a working Sonargraph project setup for your code you can use it to create a project with Sourcetrail.

-

Sonargraph Project Path

-

In this step you need to enter the path to your Sonargraph Project file and specify some additional options. Then you can see which source files have been found in the Sonargraph Project.

-
-
- -
-
- - - - - - - - -
Setting Description
Standard Select the language standard that should be used for indexing your the Source Group. Usually the most recent language standard is preselected here. (See Language Support)
Sonargraph Project S - elect the system.sonargraph file for the project. Sourcetrail will index your project based on the settings specified by the Sonargraph file. Your Sourcetrail project will stay up to date with changes in the Sonargraph project file on every refresh. You can make use of environment variables with ${ENV_VAR}.
- Interactions: -
    -
  • Clicking show source files will show you a list of all source files that will be indexed by Sourcetrail.
    • -
  • Clicking Cancel or pressing ESC will close the window and abort the setup process.
    • -
  • Clicking Next will take you to the next step of the setup process.
    • -
  • Clicking Previous will take you to the previous step of the setup process.
    • -
- -
- -

Dependencies

-

In this dialog you can specify all the dependencies your project uses.

-
-
- -
-
- - - - - - - - -
Setting Description
Class Path Enter all the .jar files your project depends on. If your project depends on uncompiled java code that should not be indexed, please add the root directory of those .java files here (the one where all the package names are relative to). You can make use of environment variables with ${ENV_VAR}.
JRE System Library Tick this box to use the JRE System library jars specified in your application settings. Disable this setting if you want to use another JRE System library for this project and add the respective jars to the project's Class Path.
- Interactions: -
    -
  • Clicking Cancel or pressing ESC will close the window and abort the setup process.
    • -
  • Clicking Next will take you to the next step of the setup process.
    • -
  • Clicking Previous will take you to the previous step of the setup process. All the information you entered will be saved.
    • -
- -
-

After this step you will return to the Project Setup Wizard.

-
- -
- - -

Create an Empty Python Source Group

+

Empty Python Source Group

Choose this option if you want to index Python files using Sourcetrail.

+

Empty Python Source Groups offer the following configuration options:

-

Indexed Paths

-

Here you provide all the information Sourcetrail needs to know about your code base.

-
-
- -
-
@@ -2576,9 +2452,13 @@ Leave blank to use the default Python environment. You can make use of environment variables with ${ENV_VAR}. - - + + + + + + - + + + +
Setting Description
Files & Directories to Index

These paths define the files and directories that will be indexed by Sourcetrail. Provide a directory to recursively add all contained source and header files. If your project's source code resides in one location, but generated source files are kept at a different location, you will also need to add that directory. You can make use of environment variables with ${ENV_VAR}.

For instructions on how to add paths see Path List Box.
Excluded Files & Directories -

These paths define the files and directories that will be left out from indexing.

+
Files & Directories to Index

These paths define the files and directories that will be indexed by Sourcetrail. Provide a directory to recursively add all contained source and header files. If your project's source code resides in one location, but generated source files are kept at a different location, you will also need to add that directory. You can make use of environment variables with ${ENV_VAR}.

For instructions on how to add paths see Path List Box.

Excluded Files & Directories

These paths define the files and directories that will be left out from indexing.

Hints:

  • You can use the wildcard * which represents characters except \ or / (e.g. src/*/test.py matches src/app/test.py but does not match src/app/widget/test.py or src/test.py)
    • @@ -2587,55 +2467,47 @@

For instructions on how to add paths see Path List Box.
Source File Extensions Define the valid extensions for source files including the dot e.g. .py. Sourcetrail will only try to index files that match one of these extensions.
Source File ExtensionsDefine the valid extensions for source files including the dot e.g. .py. Sourcetrail will only try to index files that match one of these extensions.
- Interactions: -
    -
  • Clicking Cancel or pressing ESC will close the window and abort the setup process.
    • -
  • Clicking Next will take you to the next step of the setup process.
    • -
  • Clicking Previous will take you to the previous step of the setup process. All the information you entered will be saved.
    • -
-
-

After this step you will return to the Project Setup Wizard.

-
- -
+
-

Create a Custom Command Source Group

+

Custom Command Source Group

In a Custom Command Source Group you can define a set of files and a command line call used to index each of these files. This Source Group type was introduced to integrate custom indexers written with SourcetrailDB.

-
-
- -
-
+

Custom Command Source Groups offer the following configuration options:

-

Custom Command

-

Define a command line call that will be executed for each source file in the Source Group. You can pass different pre-defined parameters:

-
    -
  • %{SOURCE_FILE_PATH}: The path to each source file in the source group (mandatory)
    • -
  • %{DATABASE_FILE_PATH}: The path to the database of the project
    • -
  • %{DATABASE_VERSION}: The database version of the used Sourcetrail instance
    • -
  • %{PROJECT_FILE_PATH}: The path to the project file
    • -
-
-
- -
-
- - - - + + + + + + + + + + + + + + - + + + +
Setting Description
Custom Command The command line call executed for each source file.
Run in Parallel Whether files should be processed in parallel.
Files & Directories to Index

These paths define the files and directories that will be indexed by Sourcetrail. Provide a directory to recursively add all contained source and header files. If your project's source code resides in one location, but generated source files are kept at a different location, you will also need to add that directory. You can make use of environment variables with ${ENV_VAR}.

For instructions on how to add paths see Path List Box.
Excluded Files & Directories -

These paths define the files and directories that will be left out from indexing.

+
Custom Command The command line call executed for each source file. You can pass different pre-defined parameters: +
    +
  • %{SOURCE_FILE_PATH}: The path to each source file in the source group (mandatory)
    • +
  • %{DATABASE_FILE_PATH}: The path to the database of the project
    • +
  • %{DATABASE_VERSION}: The database version of the used Sourcetrail instance
    • +
  • %{PROJECT_FILE_PATH}: The path to the project file
    • +
Run in Parallel Whether files should be processed in parallel.
Files & Directories to Index

These paths define the files and directories that will be indexed by Sourcetrail. Provide a directory to recursively add all contained source and header files. If your project's source code resides in one location, but generated source files are kept at a different location, you will also need to add that directory. You can make use of environment variables with ${ENV_VAR}.

For instructions on how to add paths see Path List Box.

Excluded Files & Directories

These paths define the files and directories that will be left out from indexing.

Hints:

  • You can use the wildcard * which represents characters except \ or / (e.g. src/*/test.ext matches src/app/test.ext but does not match src/app/widget/test.ext or src/test.ext)
    • @@ -2644,20 +2516,12 @@

For instructions on how to add paths see Path List Box.
Source File Extensions Define the valid extensions for source files including the dot e.g. .ext. Sourcetrail will only try to index files that match one of these extensions. If no extion is defined, any file extension is valid.
Source File ExtensionsDefine the valid extensions for source files including the dot e.g. .ext. Sourcetrail will only try to index files that match one of these extensions. If no extion is defined, any file extension is valid.
- Interactions: -
    -
  • Clicking show files will show you a list of all source files that have been detected.
    • -
  • Clicking Cancel or pressing ESC will close the window and abort the setup process.
    • -
  • Clicking Next will take you to the next step of the setup process.
    • -
  • Clicking Previous will take you to the previous step of the setup process.
    • -
- -
-

After this step you will return to the Project Setup Wizard.

-
@@ -2705,7 +2569,7 @@ --maven-path Path to the maven executable. --jre-system-library-paths Path to the jars of the JRE system library. These jars can be found inside the JRE install directory. --global-header-search-paths The Global Include Paths will be used in all your projects - in addition to the project specific Include Paths. These paths are usually passed to the compiler with the '-isystem' flag. Use them to add system header paths (See Finding System Header Locations or use the auto detection below). - --global-framework-search-paths The Global Framework Search Paths will be used in all your projects - in addition to the project specific Framework Search Paths. They define where MacOS framework containers (.framework) are found Finding System Header Locations or use the auto detection below). + --global-framework-search-paths The Global Framework Search Paths will be used in all your projects - in addition to the project specific Framework Search Paths. They define where macOS framework containers (.framework) are found Finding System Header Locations or use the auto detection below). --show Display the settings and values. diff --git a/src/lib_gui/qt/window/QtKeyboardShortcuts.cpp b/src/lib_gui/qt/window/QtKeyboardShortcuts.cpp index 35780758..c7f96087 100644 --- a/src/lib_gui/qt/window/QtKeyboardShortcuts.cpp +++ b/src/lib_gui/qt/window/QtKeyboardShortcuts.cpp @@ -223,7 +223,7 @@ QTableWidget* QtKeyboardShortcuts::createCodeViewShortcutsTable() Shortcut( QStringLiteral("Move Focus to Closest Reference"), QStringLiteral("Shift + WASD | Shift + HJKL | Shift + Arrows")), - Shortcut(QStringLiteral("Activate Focused Location"), QStringLiteral("Enter | E")), + Shortcut(QStringLiteral("Activate Location"), QStringLiteral("Enter | E")), Shortcut::defaultOrMac( QStringLiteral("Activate Location in New Tab"), QStringLiteral("Ctrl + Shift + Enter | Ctrl + Shift + E"), @@ -261,7 +261,7 @@ QTableWidget* QtKeyboardShortcuts::createGraphViewShortcutsTable() QStringLiteral("Move Focus Within Edges"), QStringLiteral("Shift + WASD | Shift + HJKL | Shift + Arrows")), Shortcut(QStringLiteral("Activate Node/Edge"), QStringLiteral("Enter | E")), - Shortcut(QStringLiteral("Expand/Collaps Node"), QStringLiteral("Shift + Enter | Shift + E")), + Shortcut(QStringLiteral("Expand/Collapse Node"), QStringLiteral("Shift + Enter | Shift + E")), Shortcut::defaultOrMac( QStringLiteral("Activate Node in New Tab"), QStringLiteral("Ctrl + Shift + Enter | Ctrl + Shift + E"), @@ -272,12 +272,12 @@ QTableWidget* QtKeyboardShortcuts::createGraphViewShortcutsTable() QStringLiteral("Cmd + Arrows")), Shortcut::defaultOrMac( QStringLiteral("Zoom in"), - QStringLiteral("Ctrl + Shift + Up | Ctrl + Mousewheel up"), - QStringLiteral("Cmd + Shift + Up | Cmd + Mousewheel up")), + QStringLiteral("Ctrl + Shift + Up | Ctrl + Mouse Wheel Up"), + QStringLiteral("Cmd + Shift + Up | Cmd + Mouse Wheel Up")), Shortcut::defaultOrMac( QStringLiteral("Zoom out"), - QStringLiteral("Ctrl + Shift + Down | Ctrl + Mousewheel down"), - QStringLiteral("Cmd + Shift + Down | Cmd + Mousewheel down")), + QStringLiteral("Ctrl + Shift + Down | Ctrl + Mouse Wheel Down"), + QStringLiteral("Cmd + Shift + Down | Cmd + Mouse Wheel Down")), Shortcut(QStringLiteral("Reset Zoom"), QStringLiteral("0")), Shortcut::defaultOrMac( QStringLiteral("Open Custom Trail Dialog"),