Skip to content

Commit

Permalink
Doc: Add docs for experimental Nim plugin
Browse files Browse the repository at this point in the history
Change-Id: Ie866334c37b626a8e6eea0d58092134d3f545d4d
Reviewed-by: Filippo Cucchetto <[email protected]>
Reviewed-by: hjk <[email protected]>
  • Loading branch information
leena-miettinen committed Jun 22, 2016
1 parent 2734d27 commit 66c0bf5
Show file tree
Hide file tree
Showing 7 changed files with 50 additions and 5 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/qtcreator-new-qt-quick-project-wizard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/qtcreator-options-code-style-nim.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions doc/src/editors/creator-editors-writing-code.qdoc
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@
\li \l{Indenting Text or Code}

\QC indents text and code according to rules that you
specify separately for files that contain C++ or QML code and for
other text files.
specify separately for files that contain C++, QML, or
Nim (experimental) code and for other text files.

\li \l{Using Qt Quick Toolbars}

Expand Down
29 changes: 29 additions & 0 deletions doc/src/editors/creator-editors.qdoc
Original file line number Diff line number Diff line change
Expand Up @@ -1190,6 +1190,8 @@

\li QML files

\li Nim files

\li Other text files

\endlist
Expand Down Expand Up @@ -1273,6 +1275,33 @@
To specify different settings for a particular project, select
\uicontrol Projects > \uicontrol {Code Style Settings}.

\section1 Indenting Nim Files

To specify settings for the Nim editor (experimental):

\list 1

\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Nim.

\li In the \uicontrol {Current settings} field, select the settings to
modify and click \uicontrol Copy.

\image qtcreator-options-code-style-nim.png "Nim Code Style options"

\li Give a name to the settings and click \uicontrol OK.

\li Click \uicontrol Edit to specify code style settings for the project.

\image qtcreator-code-style-settings-edit-nim.png "Edit Code Style Settings dialog"

\endlist

You can specify how to interpret the \key Tab key presses and how to align
continuation lines.

To specify different settings for a particular project, select
\uicontrol Projects > \uicontrol {Code Style}.

\section1 Indenting Other Text Files

To specify indentation settings for text files that do not contain C++ or
Expand Down
19 changes: 17 additions & 2 deletions doc/src/projects/creator-projects-creating.qdoc
Original file line number Diff line number Diff line change
Expand Up @@ -213,11 +213,22 @@

\list

\li Plain C or C++ Project
\li Plain C or C++ Application

Plain C or C++ project that uses qmake, Qbs, or CMake but does
Plain C or C++ application that uses qmake, Qbs, or CMake but does
not use the Qt library

\li Nim Application (experimental)

\l{http://nim-lang.org/}{Nim} application that uses qmake
or CMake but does not use the Qt library

\note The \uicontrol {Nim Application} option becomes visible
after you enable the experimental Nim plugin. Select
\uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Other Languages} > \uicontrol Nim, and then restart
\QC.

\endlist

\li Import Project
Expand Down Expand Up @@ -316,6 +327,10 @@
Python class and source files that you can use to create Python
classes and scripts with UTF-8 encoding.

\li Nim (experimental)

Nim source files with UTF-8 encoding.

\endlist

\section2 Creating C++ Classes
Expand Down
3 changes: 2 additions & 1 deletion doc/src/projects/creator-projects-settings-build.qdoc
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,8 @@

You can specify command-line arguments in the arguments fields:
\uicontrol {Additional arguments}, \uicontrol {Command arguments},
\uicontrol {Make arguments}, or \uicontrol Arguments. You can create shell command lines
\uicontrol {Make arguments}, \uicontrol Arguments, \uicontrol {Default Arguments},
or \uicontrol {Extra arguments}. You can create shell command lines
that can contain redirection and other advanced constructs. However, some
more complex use cases, such as piping test data into the application being
tested or grouping commands, are not supported because the value of the
Expand Down

0 comments on commit 66c0bf5

Please sign in to comment.