Skip to content

Commit

Permalink
Added module documentation and license files.
Browse files Browse the repository at this point in the history
  • Loading branch information
s-ludwig committed Oct 15, 2012
1 parent 011aadf commit 5d122c4
Show file tree
Hide file tree
Showing 14 changed files with 87 additions and 26 deletions.
7 changes: 7 additions & 0 deletions LICENSE.txt
@@ -0,0 +1,7 @@
Copyright (c) 2012 RejectedSoftware e.K.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
7 changes: 7 additions & 0 deletions LICENSE_DE.txt
@@ -0,0 +1,7 @@
Copyright (c) 2012 RejectedSoftware e.K.

Hiermit wird unentgeltlich, jeder Person, die eine Kopie der Software und der zugeh�rigen Dokumentationen (die "Software") erh�lt, die Erlaubnis erteilt, uneingeschr�nkt zu benutzen, inklusive und ohne Ausnahme, dem Recht, sie zu verwenden, kopieren, �ndern, fusionieren, verlegen, verbreiten, unterlizenzieren und/oder zu verkaufen, und Personen, die diese Software erhalten, diese Rechte zu geben, unter den folgenden Bedingungen:

Der obige Urheberrechtsvermerk und dieser Erlaubnisvermerk sind in allen Kopien oder Teilkopien der Software beizulegen.

DIE SOFTWARE WIRD OHNE JEDE AUSDR�CKLICHE ODER IMPLIZIERTE GARANTIE BEREITGESTELLT, EINSCHLIESSLICH DER GARANTIE ZUR BENUTZUNG F�R DEN VORGESEHENEN ODER EINEM BESTIMMTEN ZWECK SOWIE JEGLICHER RECHTSVERLETZUNG, JEDOCH NICHT DARAUF BESCHR�NKT. IN KEINEM FALL SIND DIE AUTOREN ODER COPYRIGHTINHABER F�R JEGLICHEN SCHADEN ODER SONSTIGE ANSPR�CHE HAFTBAR ZU MACHEN, OB INFOLGE DER ERF�LLUNG EINES VERTRAGES, EINES DELIKTES ODER ANDERS IM ZUSAMMENHANG MIT DER SOFTWARE ODER SONSTIGER VERWENDUNG DER SOFTWARE ENTSTANDEN.
2 changes: 1 addition & 1 deletion README.md
@@ -1,4 +1,4 @@
DDocX documentation engine
DDOX documentation engine
==========================

First steps
Expand Down
9 changes: 8 additions & 1 deletion source/ddox/api.d
@@ -1,6 +1,13 @@
/**
Internal functions for use inside the HTML templates.
Copyright: © 2012 RejectedSoftware e.K.
License: Subject to the terms of the MIT license, as written in the included LICENSE.txt file.
Authors: Sönke Ludwig
*/
module ddox.api;

import ddox.entities;
public import ddox.ddox;

import std.array;
import std.format;
Expand Down
27 changes: 12 additions & 15 deletions source/ddox/ddox.d
@@ -1,17 +1,14 @@
module ddox.ddox;


/**
Central import for all DDOX functionality.
enum SortMode {
None,
Name
}

class DdoxSettings {
bool moduleNavAsTree = false;
SortMode moduleSort = SortMode.Name;
SortMode declSort = SortMode.None;
bool inheritDocumentation = true;
bool mergeEponymousTemplates = true;
}
Copyright: © 2012 RejectedSoftware e.K.
License: Subject to the terms of the MIT license, as written in the included LICENSE.txt file.
Authors: Sönke Ludwig
*/
module ddox.ddox;

public import ddox.ddox;
public import ddox.entities;
public import ddox.htmlgenerator;
public import ddox.htmlserver;
public import ddox.settings;
7 changes: 7 additions & 0 deletions source/ddox/entities.d
@@ -1,3 +1,10 @@
/**
Contains definitions of the syntax tree elements.
Copyright: © 2012 RejectedSoftware e.K.
License: Subject to the terms of the MIT license, as written in the included LICENSE.txt file.
Authors: Sönke Ludwig
*/
module ddox.entities;

import std.string;
Expand Down
12 changes: 8 additions & 4 deletions source/ddox/htmlgenerator.d
@@ -1,7 +1,15 @@
/**
Generates offline documentation in the form of HTML files.
Copyright: © 2012 RejectedSoftware e.K.
License: Subject to the terms of the MIT license, as written in the included LICENSE.txt file.
Authors: Sönke Ludwig
*/
module ddox.htmlgenerator;

import ddox.api;
import ddox.entities;
import ddox.settings;

import std.array;
import std.variant;
Expand All @@ -13,10 +21,6 @@ import vibe.stream.stream;
import vibe.templ.diet;


class GeneratorSettings {
bool navPackageTree = true;
}

/*
structure:
/index.html
Expand Down
8 changes: 8 additions & 0 deletions source/ddox/htmlserver.d
@@ -1,9 +1,17 @@
/**
Serves documentation on through HTTP server.
Copyright: © 2012 RejectedSoftware e.K.
License: Subject to the terms of the MIT license, as written in the included LICENSE.txt file.
Authors: Sönke Ludwig
*/
module ddox.htmlserver;

import ddox.api;
import ddox.ddoc; // just so that rdmd picks it up
import ddox.entities;
import ddox.htmlgenerator;
import ddox.settings;

import std.array;
import std.string;
Expand Down
9 changes: 8 additions & 1 deletion source/ddox/jsonparser.d
@@ -1,3 +1,10 @@
/**
Parses DMD JSON output and builds up a socumentation syntax tree.
Copyright: © 2012 RejectedSoftware e.K.
License: Subject to the terms of the MIT license, as written in the included LICENSE.txt file.
Authors: Sönke Ludwig
*/
module ddox.jsonparser;

import ddox.ddox;
Expand Down Expand Up @@ -44,7 +51,7 @@ Package parseJsonDocs(Json json, DdoxSettings settings, Package root = null)
return root;
}

struct Parser
private struct Parser
{
private Tuple!(Type, Entity)[] m_primTypes;
private Declaration[string] m_typeMap;
Expand Down
7 changes: 7 additions & 0 deletions source/ddox/processors/eptemplates.d
@@ -1,3 +1,10 @@
/**
Merges eponymous templates to a single definition with template arguments.
Copyright: © 2012 RejectedSoftware e.K.
License: Subject to the terms of the MIT license, as written in the included LICENSE.txt file.
Authors: Sönke Ludwig
*/
module ddox.processors.eptemplates;

import ddox.api;
Expand Down
7 changes: 7 additions & 0 deletions source/ddox/processors/inherit.d
@@ -1,3 +1,10 @@
/**
Inherits non-existing members and documentation from anchestor classes/intefaces.
Copyright: © 2012 RejectedSoftware e.K.
License: Subject to the terms of the MIT license, as written in the included LICENSE.txt file.
Authors: Sönke Ludwig
*/
module ddox.processors.inherit;

import ddox.api;
Expand Down
7 changes: 7 additions & 0 deletions source/ddox/processors/sort.d
@@ -1,3 +1,10 @@
/**
Sorts packages, modules and definitions in the syntax tree.
Copyright: © 2012 RejectedSoftware e.K.
License: Subject to the terms of the MIT license, as written in the included LICENSE.txt file.
Authors: Sönke Ludwig
*/
module ddox.processors.sort;

import ddox.entities;
Expand Down
2 changes: 0 additions & 2 deletions views/ddox.composite.dt
Expand Up @@ -2,8 +2,6 @@ extends ddox.layout

block ddox.defs
- import ddox.api;
- import ddox.ddoc;
- import ddox.entities;
- import std.algorithm;
- import std.typetuple;

Expand Down
2 changes: 0 additions & 2 deletions views/ddox.enum.dt
Expand Up @@ -2,8 +2,6 @@ extends ddox.layout

block ddox.defs
- import ddox.api;
- import ddox.ddoc;
- import ddox.entities;
- import std.algorithm;

- auto enum_item = cast(EnumDeclaration)info.item;
Expand Down

0 comments on commit 5d122c4

Please sign in to comment.