diff --git a/web/documentation/img/status_bar.png b/web/documentation/img/status_bar.png index 8fe9d600..7ae66d91 100644 Binary files a/web/documentation/img/status_bar.png and b/web/documentation/img/status_bar.png differ diff --git a/web/documentation/index.html b/web/documentation/index.html index d1a6d08e..6d834622 100644 --- a/web/documentation/index.html +++ b/web/documentation/index.html @@ -172,7 +172,7 @@

Source Analysis

-

Coati will now start analyzing your source files, which might take a little while. The status bar will give you information about the progress. Otherwise the UI will be empty. Coati analyses all named symbols and their relationships throughout the provided source files. However, it stops the analysis at the level of local variables and symbols that are only valid within a certain function scope.

+

Coati will now start analyzing your source files, which might take a little while. The status bar will give you information about the progress. Otherwise the UI will be empty. Coati analyses all named symbols and their relationships throughout the provided source files.

@@ -185,7 +185,7 @@
  • or Press ESC to stop the analysis (Coati will provide all information gathered so far and the analysis can be continued later by refreshing).
    • -

    After analysis has finished, Coati will show an overview of all analysed symbols in the graph view and some statistics in the code view. If the analysis found errors in your code, the code view will display them. You can see the error message by hovering an error's location.

    +

    After the analysis has finished, Coati will show an overview of all analysed symbols in the graph view and some statistics in the code view. If the analysis found errors in your code, the code view will display them. You can see the error message by hovering an error's location.

    @@ -257,7 +257,7 @@

    Code View

    -

    The code view displays all locations of the currently active symbol within the analyzed source files. It does not allow for editing the source code. Syntax highlighting is used to increase readability. Source locations that are surrounded by a box when hovered can be clicked to activate the respective symbol. Active source locations are highlighted gray.

    +

    The code view displays all locations of the currently active symbol within the analyzed source files. It does not allow for editing the source code. Syntax highlighting is used to increase readability. Source locations that are surrounded by a box when hovered can be clicked to activate the respective symbol. Active source locations are highlighted.

    @@ -352,10 +352,10 @@

    INSTALLATION

    -

    on Windows

    +

    On 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 Coati from your start menu.

    -

    on Mac

    +

    On Mac

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

    @@ -363,7 +363,7 @@
    -

    on Linux

    +

    On Linux

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

    Data folder

    @@ -381,19 +381,19 @@

    Finding System Header Locations

    -

    on Windows

    +

    On 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

    +

    On Mac

    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

    +

    On Linux

    gcc -x c++ -v -E /dev/null
    or 
    clang -x c++ -v -E /dev/null
    @@ -482,8 +482,8 @@ Setting Description - Header Search Paths Set header search paths that are used for all of your projects (e.g. std headers). (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) - Framework Search Paths Mac only. Define the search paths for .framework files for all of your projects. (For instructions on how to add paths see Path List Box.) + Header Search 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.) + Framework Search Paths Mac only. Define the search paths for .framework files for all of your projects. An option for automatic detection of these paths is available for Clang and GCC. (For instructions on how to add paths see Path List Box.) @@ -586,9 +586,7 @@

    Create a Project from Compilation Database

    If you are using CMake you can export compile commands by defining the flag CMAKE_EXPORT_COMPILE_COMMANDS. Just select the exportet .json file in the file picker.

    -

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

    +

    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.

    Compilation Database Headers

    In the next step you can define the locations of the corresponding header files of the source files in the compilation database.

    @@ -1149,7 +1147,7 @@
  • Press the right auto refresh button to toggle automatic refreshing.
    • -

    Overview button

    +

    Overview Button

    Show the overview screen, which gives a summary of the loaded project. The overview screen is shown after the project was loaded. Alternatively use the shortcut To overview.

    @@ -1161,7 +1159,7 @@
  • Press the overview button to show the project overview.
    • -

    Search bar

    +

    Search Bar

    The search bar allows you to enter search requests to find one of Coati's analyzed symbols. It doesn't allow for full text searching across all files so far. The search field allows for most text editing interactions common to text fields. When typing your request the Autocompletion Popup will show you search results matching to your entered string.