• API Documentation

Project settings

Project settings, which are compiled by the BuildSystem, are stored in a JSON file. The path to this JSON file is specified in the global settings.

Processed keys

  • type - type of project:
    • Idl;
    • CSharp;
    • Cpp;
    • Delphi;
    • Res;
  • project_path - path to main project file (dporj / csproj / idl / etc) - it may me absolute or relative to the current JSON file;
  • scope - a project group that allows tasks to be executed only on a specific scope (default value is "main");
  • sources - list of patterns for specifying paths to the project's source files;
  • content - list of paths to files and folders (without the ability to specify masks) that will be considered the content of the project;
  • packages - list of settings that control the process of creating a binary files, which can be published to a repository, such as nuget.org;
  • platforms - list of platforms for which the project can be compiled;
  • build_params - list of parameters that will be passed to the compiling process - these values will take precedence over global settings of the manager object.
  • dependencies - list of
    • other projects on which the current project depends;
    • packages in binrary storage, like NuGet.org and so on.

Possible variables

Values may include variables that will be replaced during the file analysis process:

  • Information about processing project:
    • $native_project:name$ - the name of the main project file without the extension;
    • $native_project:path$ - the full path to the main project file;
    • $native_project:type$ - type of project (value of "type" in JSON);
  • Infromation about project, as part of BuildSystem:
    • $project:output_dll$ - path to result DLL, if project compilation generates DLL file (similarly, a variable can be used for other file extensions);
    • $project:build_result_default_path$ - path to folder, where all compilation results will be stored;
    • $project:doc_folder$ - path to temp folder, where HTML-files will be stored;
  • Information about JSON file with settings:
    • $project_json:folder$ - path to folder with JSON file;
    • $project_json:name$ - name of JSON file.
In This Article
Back to top Generated by DocFX