From b95c6a3de43121c061457039a4c926d5d34f2737 Mon Sep 17 00:00:00 2001
From: jsteuer <jan.steuer.htw@gmail.com>
Date: Mon, 16 Dec 2019 13:28:22 +0100
Subject: [PATCH] better docs, helpers namespace
---
mathcoach-api.d.ts | 20 +++++++++++---------
1 files changed, 11 insertions(+), 9 deletions(-)
diff --git a/mathcoach-api.d.ts b/mathcoach-api.d.ts
index b5ed739..bb80ace 100644
--- a/mathcoach-api.d.ts
+++ b/mathcoach-api.d.ts
@@ -1,4 +1,3 @@
-
/**
* Wenn die Bibliothek zur Erweiterung der IDE eingebunden (`ide-lib.js`) wurde,
* steht diese globale Variable mit Zugang zur öffentlichen Schnittstelle
@@ -9,14 +8,17 @@
/**
* Der MathCoach-Namensraum ist die Sammelstelle für alle öffentlichen Schnittstellen.
* Somit können auch externe Module (z.B. grafische Editoren) typsicher erstellt werden.
+ *
* Als Einstiegspunkt dient das interface `MathCoach.Api` - eine Implementierung dieser Schnittstelle
* wird von der IDE (siehe `ide-lib.js`) bereitgestellt und kann über die globale Variable
* `MC` zugegriffen werden.
*/
declare namespace MathCoach {
- /**
- * Einstiegspunkt zur MathCoach API Schnittstelle
+ /**
+ * Als Einstiegspunkt dient das interface `MathCoach.Api` - eine Implementierung dieser Schnittstelle
+ * wird von der IDE (siehe `ide-lib.js`) bereitgestellt und kann über die globale Variable
+ * `MC` zugegriffen werden.
*/
interface Api {
/**
@@ -55,7 +57,7 @@
*/
interface IdeApi {
/**
- * Name des aktuellen Benutzers.
+ * Gibt den Namen des aktuellen Benutzers zurück, der mit dem Werkzeug arbeitet.
*
* Anwendungsbeisipiel:
*
@@ -64,7 +66,7 @@
*/
getUserName(): Promise<string>;
/**
- * Verweis auf die Datei, mit der das Entwicklerwerkzeug gestartet wurde.
+ * Gibt den Verweis auf die Datei zurück, mit der das Entwicklerwerkzeug gestartet wurde.
*
* Anwendungsbeispiel:
*
@@ -73,16 +75,16 @@
*/
getContextFile(): Promise<File>;
/**
- * Schnittstelle zum Dateisystem
+ * Einstiegspunkt der Dateisystem-Schnittstelle (z.B. um Dateien zu lesen und zu schreiben)
*/
readonly fs: FileSystemApi;
/**
- * Schnittstelle zur Vorschau
+ * Einstiegspunkt der Vorschau-Schnittstelle (z.B. um generierte Aufgaben zu starten)
*/
readonly navigator: NavigatorApi;
}
/**
- * Schnittstelle zur Navigations-Vorschau
+ * Schnittstelle zur Navigation der Vorschau
*/
interface NavigatorApi {
/**
@@ -101,7 +103,7 @@
/**
* Navigiert die Vorschau zu einer MathCoach-Aufgabe.
* Hinweis: Die Datei muss im `vfs`-Teil des Dateisystems liegen und
- * eine ausführbar sein (z.B. eine groovy-Datei).
+ * eine ausführbare MathCoach-Aufgabe sein (z.B. eine groovy-Datei).
*
* Anwendungsbeispiel:
*
--
Gitblit v1.10.0-SNAPSHOT