Skip to content
This repository has been archived by the owner on Apr 30, 2020. It is now read-only.

Commit

Permalink
Merge branch 'dev'
Browse files Browse the repository at this point in the history
  • Loading branch information
Gerrit "Geaz" Gazic committed Sep 10, 2015
2 parents 191acea + a78ac5c commit 6d6ceab
Show file tree
Hide file tree
Showing 208 changed files with 4,270 additions and 1,977 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ x64/

build/
nuget/
nuget-beta/
!src/SharpDox.Sdk/Build/

# Enable "build/" folder in the NuGet Packages folder since NuGet packages use it for MSBuild targets
Expand Down
12 changes: 12 additions & 0 deletions CHANGELOG.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
Version 1.0rc

- Created two seperate executes (gui and console)
- Changed Model: sharpDox now parses one repository per build target (thanks to [Geert van Horrik](https://github.com/GeertvanHorrik))
- Creates the output path now, if necessary
- Added console exit codes
- Config file is static now - no last build info anymore
- sharpDox is able to parse unity solutions now
- Added Array Element Types to SDType model
- Reworked HTML Output
- Some more minor changes

Version 0.9.10

- The output window opens automatically, if the build fails
Expand Down
3 changes: 2 additions & 1 deletion build.bat
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
set msBuildDir=%WINDIR%\Microsoft.NET\Framework\v4.0.30319
call nuget.exe restore src

set msBuildDir=%WINDIR%\Microsoft.NET\Framework\v4.0.30319
call %msBuildDir%\msbuild "msbuild.config" /p:Configuration=Build
6 changes: 3 additions & 3 deletions doc/Articles/de/de.advanced-tutorial.sda
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ Neben der eigentlichen Code-Dokumentation können Artikel, erweiterte Beschreibu
*sharpDox* ermöglicht es auch für Namensräumen komplexere Beschreibungen zu erstellen. Dazu unterhalb der Eingabedatei eine Datei mit folgendem Format erstellt werden: `Namens.raum.Name.sdnd`
Für die Textformatierung kann die Markdown-Syntax genutzt werden.Die Datei mit dem Namen `SharpDox.Sdk.sdnd` wird zum Beispiel für den Namensraum `SharpDox.Sdk` genutzt.

###Artikel###
### Artikel ###
Neben Beschreibungen und der Dokumentation des Codes können in *sharpDox* auch Artikel Bestandteil einer Dokumentation sein.

Artikel sind dabei zusätzliche Seiten innerhalb der Dokumentation, die über eine benutzerdefinierte Navigation erreichbar sind. Für Artikel ist es zwingend notwendig, dass eine Navigation erstellt wurde. Ansonsten werden Artikel während des Bauvorgangs nicht berücksichtigt.

Um einen Artikel in einer Markdown-Syntax zu erstellen, muss lediglich eine Datei mit der Endung `.sda` in einem beliebigen Ordner erstellt werden. *sharpDox* erkennt alle in der Navigation referenzierten Artikel und liest diese automatisch ein. Siehe den Punkt *Navigation* für Informationen wie diese Artikel verlinkt werden können.
### Tokens ### Es kann eine Liste mit Tokens erstellt werden die innerhalb von Beschreibungen & Artikeln genutzt werden können. Dazu muss eine Datei mit dem Namen `tokens.sdt` unterhalb der Eingabedatei liegen. Diese Datei wird während des Bauvorgangs eingelesen und den Exportern übergeben.Pro Zeile der Datei kann ein Token in der Form TokenName = TokenWertangelegt werden. Dieser Token kann dann zum Beispiel in einem Artikel genutzt werden.Dazu wird die folgende Syntax genutzt: {{"token:BUILD_SERVER}}Bitte das `"` aus der oberen Syntax entfernen. Dieses wurde eingefügt, damit *sharpDox* nicht versucht das Beispiel zu ersetzen.
###Links###
### Links ###
Innerhalb von Beschreibungen und Artikeln können auf verschiedene Elemente innerhalb der Dokumentation verlinkt werden. Außerdem ist es möglich auf Bilder innerhalb der Lösung zu verlinken.

Bitte erneut das `"` aus den Beispielen entfernen.
Expand All @@ -29,7 +29,7 @@ Bilder: Unterhalb der Eingabedatei können Bilder abgelegt werden die in Beschre

> Beispiel: `!\[Shell]({{"image-link:sdi.startSD.png}})`

###Navigation###
### Navigation ###
Das wichtigste Element einer erweiterten Dokumentation ist die Navigation. Mit dieser kann festgelegt werden wie die Struktur der Dokumentation aufgebaut ist. Als Beispiel soll die Navigation der *sharpDox* Dokumentation genommen werden:

-Einführung#de.introduction -Benutzer --Erstellen von erweiterten Dokumentationen#de.advanced-tutorial --Erstellen von mehrsprachigen Dokumentationen#de.multilang-tutorial -Entwickler --Erstellen eines Exporters#de.exporter-tutorial --API#..\SharpDox.sln
Expand Down
12 changes: 2 additions & 10 deletions doc/Articles/de/de.introduction.sda
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
Die Benutzung von *sharpDox* gestaltet sich, im Gegensatz zu manch anderen Dokumentationstools,
als sehr einfach. Nachdem *sharpDox* heruntergeladen und entpackt wurde, kann es über die
*Sharpdox.Core.exe* gestartet werden.

![Shell]({{image-link:sdi.startSD.png}})

Entwicklern ist es möglich, für *sharpDox* neue Benutzeroberflächen zu implementierten.
Sind mehrere dieser Benutzeroberflächen im Ordner *shells* von *sharpDox* vorhanden,
bietet das Programm dem Benutzer eine Auswahl der registrierten Benutzeroberflächen an.
Sollte nur eine Benutzeroberfläche benötigt werden, können die übrigen Oberflächen bedenkenlos
aus dem *shells* Ordner entfernt werden.
*Sharpdox.Gui.exe* oder *SharpDox.Console.exe* gestartet werden.

Es empfiehlt sich *sharpDox* das erstemal mit der GUI zu starten.
Mittels der GUI kann die Konfiguration der eigenen Dokumentation einfach angepasst werden.
Expand All @@ -17,7 +9,7 @@ Je nach registrierten Plugins bietet die GUI unterschiedliche Konfigurationspunk
![Introduction]({{image-link:sdi.introduction.png}})

*sharpDox* ermöglicht es Entwicklern verschiedene Ausgabeformate für eine Dokumentation zu erstellen.
Dies versetzt den Benutzer in die Lage die Ausgabeform der Dokumentation zu beeinflussen ([hier]({{article-link:Erstellen eines Exporters}})
Dies versetzt den Benutzer in die Lage die Ausgabeform der Dokumentation zu beeinflussen ([hier]({{article-link:de.exporter-tutorial}})
ist ein Beispiel zu finden wie ein Exporter erstellt werden kann). Plugins befinden sich im *plugin* Ordner von *sharpDox*.
Neue Plugins werden durch einen Neustart des Programms registriert und automatisch während des Bauvorgangs ausgeführt.

Expand Down
2 changes: 1 addition & 1 deletion doc/Articles/en/advanced-tutorial.sda
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Just create a file with the name _default.sdpd_ underneath the input file path.
*sharpDox* is able to parse custom descriptions for namespaces. Just create a file with a `.sdnd` extension and write your description in the markdown syntax. *sharpDox* recognizes these files as namespace descriptions.
If you want a description for the namespace `SharpDox.Sdk`, create the file `SharpDox.Sdk.sdnd`.

###Articles###
### Articles ###

Besides the code documentation and the description it is also possible to create articles. Articles are additional pages inside the documentation, which are accessible through a custom navigation. It is mandatory to create a custom navigation, if you use articles. Otherwise the articles get ignored.

Expand Down
10 changes: 2 additions & 8 deletions doc/Articles/en/introduction.sda
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
Building code documentation with *sharpDox* is really easy. Just download it,
extract the zip file to any location and start the *SharpDox.Core.exe*.

![Shell]({{image-link:sdi.en.startSD.png}})

Developers are able to create additional shells for *sharpDox*. If more than one shell
is available in the folder _shells_, *sharpdox* will ask which one should get started.
If you only need one shell please delete the other ones.
extract the zip file to any location and start the *SharpDox.Gui.exe* or *SharpDox.Console.exe*.

To create your first documentation it is suggested to start the GUI of *sharpDox*.
The GUI helps you to create a config for your documentation. Exporters are able to provide
Expand All @@ -16,7 +10,7 @@ additional settings which are available as additional categories.
Developers are able to create different output formats for the code documentation.
Besides the chm documentation, which is delivered together with *sharpDox*, it is possible to create additional exporters as plugins. You only have to download/develop
the exporter and drop it into the *plugin* folder of *sharpDox*. The new exporter will
be registered during a restart of **sharpDox** and gets executed during the build process (find [here]({{article-link:Create a exporter}}) a tutorial to create an own exporter).
be registered during a restart of **sharpDox** and gets executed during the build process (find [here]({{article-link:exporter-tutorial}}) a tutorial to create an own exporter).

If you provided all needed settings, the documentation is ready to build. Press _Build_ to start the build process. After the successful build your documentation is located
in the given output path. *sharpDox* creates a subfolder for each registered exporter.
Expand Down
Binary file removed doc/Images/sdi.en.startSD.png
Binary file not shown.
Binary file removed doc/Images/sdi.startSD.png
Binary file not shown.
Binary file modified libs/ICSharpCode.NRefactory.CSharp.dll
Binary file not shown.
Binary file modified libs/ICSharpCode.NRefactory.Cecil.dll
Binary file not shown.
Binary file modified libs/ICSharpCode.NRefactory.Xml.dll
Binary file not shown.
Binary file modified libs/ICSharpCode.NRefactory.dll
Binary file not shown.
64 changes: 35 additions & 29 deletions msbuild.config
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
<PropertyGroup>
<OutDir>$(MSBuildStartupDirectory)\build</OutDir>
<NuGetDir>$(MSBuildStartupDirectory)\nuget</NuGetDir>
<NuGetBetaDir>$(MSBuildStartupDirectory)\nuget-beta</NuGetBetaDir>
<SolutionProperties>
Platform=Any CPU;
Configuration=Release
Expand All @@ -13,54 +14,59 @@
$(SolutionProperties)
</Properties>
</Solution>

<MainFiles Include="src/SharpDox.Core/bin/Release/SharpDox.Core.exe;
src/SharpDox.Core/bin/Release/SharpDox.Core.exe.config"/>

<LanguageFiles Include="lang/*"/>

<ShellFiles Include="src/Shells/SharpDox.GUI/bin/Release/SharpDox.GUI.dll;
src/Shells/SharpDox.Console/bin/Release/SharpDox.Console.dll"/>
<ShellFiles Include="src/Shells/SharpDox.GUI/bin/Release/SharpDox.GUI.exe;
src/Shells/SharpDox.GUI/bin/Release/SharpDox.GUI.exe.config;
src/Shells/SharpDox.Console/bin/Release/SharpDox.Console.exe;
src/Shells/SharpDox.Console/bin/Release/SharpDox.Console.exe.config"/>

<LibraryFiles Include="src/SharpDox.Core/bin/Release/Autofac.Configuration.dll;
src/SharpDox.Core/bin/Release/Autofac.dll;
src/SharpDox.Core/bin/Release/ICSharpCode.NRefactory.Cecil.dll;
src/SharpDox.Core/bin/Release/ICSharpCode.NRefactory.CSharp.dll;
src/SharpDox.Core/bin/Release/ICSharpCode.NRefactory.dll;
src/SharpDox.Core/bin/Release/ICSharpCode.NRefactory.Xml.dll;
src/SharpDox.Core/bin/Release/log4net.dll;
src/SharpDox.Core/bin/Release/Mono.Cecil.dll;
src/SharpDox.Core/bin/Release/SharpDox.Build.dll;
src/SharpDox.Core/bin/Release/SharpDox.Build.NRefactory.dll;
src/SharpDox.Core/bin/Release/SharpDox.Config.dll;
src/SharpDox.Core/bin/Release/SharpDox.ConsoleHelper.dll;
src/SharpDox.Core/bin/Release/SharpDox.Local.dll;
src/SharpDox.Core/bin/Release/SharpDox.Model.dll;
src/SharpDox.Core/bin/Release/SharpDox.Sdk.dll;
src/SharpDox.Core/bin/Release/SharpDox.UML.dll"/>
<LibraryFiles Include="src/Core/SharpDox.Core/bin/Release/Autofac.dll;
src/Core/SharpDox.Core/bin/Release/ICSharpCode.NRefactory.Cecil.dll;
src/Core/SharpDox.Core/bin/Release/ICSharpCode.NRefactory.CSharp.dll;
src/Core/SharpDox.Core/bin/Release/ICSharpCode.NRefactory.dll;
src/Core/SharpDox.Core/bin/Release/ICSharpCode.NRefactory.Xml.dll;
src/Core/SharpDox.Core/bin/Release/log4net.dll;
src/Core/SharpDox.Core/bin/Release/Mono.Cecil.dll;
src/Core/SharpDox.Core/bin/Release/SharpDox.Build.dll;
src/Core/SharpDox.Core/bin/Release/SharpDox.Build.NRefactory.dll;
src/Core/SharpDox.Core/bin/Release/SharpDox.Model.dll;
src/Core/SharpDox.Core/bin/Release/SharpDox.Sdk.dll;
src/Core/SharpDox.Core/bin/Release/SharpDox.Core.dll;
src/Libraries/SharpDox.UML/bin/Release/SharpDox.UML.dll;"/>

<AdditionalFiles Include="CHANGELOG.txt"/>

<NugetSpecFile Include="sharpDox SDK.nuspec"/>
<NugetFiles Include="src/SharpDox.Core/bin/Release/SharpDox.Model.dll;
src/SharpDox.Core/bin/Release/SharpDox.Sdk.dll;
src/SharpDox.Core/bin/Release/SharpDox.UML.dll"/>
<NugetFiles Include="src/Core/SharpDox.Core/bin/Release/SharpDox.Model.dll;
src/Core/SharpDox.Core/bin/Release/SharpDox.Sdk.dll;
src/Libraries/SharpDox.UML/bin/Release/SharpDox.UML.dll"/>
<NugetPackage Include="SharpDox.SdkPackage*"/>

<NugetBetaSpecFile Include="sharpDox SDK-beta.nuspec"/>
<NugetBetaFiles Include="src/Core/SharpDox.Core/bin/Release/SharpDox.Model.dll;
src/Core/SharpDox.Core/bin/Release/SharpDox.Sdk.dll;
src/Libraries/SharpDox.UML/bin/Release/SharpDox.UML.dll"/>
<NugetBetaPackage Include="SharpDox.SdkPackage*"/>

</ItemGroup>
<Target Name="Build">
<RemoveDir Directories="$(OutDir)" />
<MSBuild Projects="@(Solution)" Targets="Clean;Build" />
<Copy SourceFiles="@(MainFiles)" DestinationFolder="$(OutDir)" />
<Copy SourceFiles="@(ShellFiles)" DestinationFolder="$(OutDir)" />
<Copy SourceFiles="@(LibraryFiles)" DestinationFolder="$(OutDir)\libs" />
<Copy SourceFiles="@(ShellFiles)" DestinationFolder="$(OutDir)\shells" />
<Copy SourceFiles="@(LanguageFiles)" DestinationFolder="$(OutDir)\lang" />
<Copy SourceFiles="@(AdditionalFiles)" DestinationFolder="$(OutDir)" />

<RemoveDir Directories="$(NuGetDir)" />
<Copy SourceFiles="@(NugetSpecFile)" DestinationFolder="$(NuGetDir)" />
<Copy SourceFiles="@(NugetFiles)" DestinationFolder="$(NuGetDir)\lib\net40" />
<Exec Command="..\src\.nuget\NuGet.exe pack %22sharpDox SDK.nuspec%22" WorkingDirectory="$(NuGetDir)"/>
<Exec Command="..\nuget.exe pack %22sharpDox SDK.nuspec%22" WorkingDirectory="$(NuGetDir)"/>
<RemoveDir Directories="$(NuGetDir)\lib\" />
<Delete Files="$(NuGetDir)\sharpDox SDK.nuspec"/>

<Copy SourceFiles="@(NugetBetaSpecFile)" DestinationFolder="$(NuGetBetaDir)" />
<Copy SourceFiles="@(NugetBetaFiles)" DestinationFolder="$(NuGetBetaDir)\lib\net40" />
<Exec Command="..\nuget.exe pack %22sharpDox SDK-beta.nuspec%22" WorkingDirectory="$(NuGetBetaDir)"/>
<RemoveDir Directories="$(NuGetBetaDir)\lib\" />
</Target>
</Project>
Binary file added nuget.exe
Binary file not shown.
14 changes: 14 additions & 0 deletions sharpDox SDK-beta.nuspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
<metadata>
<id>sharpDoxSDK</id>
<version>0.9.11.14-beta</version>
<title>sharpDox SDK</title>
<authors>Gerrit 'Geaz' Gazic</authors>
<owners>Gerrit 'Geaz' Gazic</owners>
<projectUrl>http://sharpdox.de</projectUrl>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>This package contains all files necessary to create you own plugins for sharpDox.</description>
<copyright>Copyright © 2014</copyright>
</metadata>
</package>
2 changes: 1 addition & 1 deletion sharpDox SDK.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
<metadata>
<id>sharpDoxSDK</id>
<version>0.9.10</version>
<version>1.0</version>
<title>sharpDox SDK</title>
<authors>Gerrit 'Geaz' Gazic</authors>
<owners>Gerrit 'Geaz' Gazic</owners>
Expand Down
6 changes: 0 additions & 6 deletions src/.nuget/NuGet.Config

This file was deleted.

Binary file removed src/.nuget/NuGet.exe
Binary file not shown.
Loading

0 comments on commit 6d6ceab

Please sign in to comment.