Angenommen, ich habe eine Klasse in einem Paket namens mypackage.myclass geschrieben. Ich habe meine eigene HTML-Dokumentation für das Paket und die Klasse geschrieben und diese in den MATLAB-Hilfebrowser eingefügt, wie in die MATLAB-Dokumentation .
Ich kann diese HTML-Dokumentation anzeigen, indem ich den Hilfe-Browser verwende, um direkt dorthin zu navigieren, aber die Eingabe von doc mypackage.myclass zeigt ihn nicht an; Stattdessen wird eine HTML-Dokumentation angezeigt, die automatisch von helpwin generiert wird (was ein nettes Feature ist, aber nicht das, was ich möchte - die automatisch generierte Dokumentation ist für meine Benutzer zu technisch).
Wie kann ich doc dazu zwingen, meine Dokumentation anstatt der automatisch generierten Dokumentation anzuzeigen?
Äquivalent:
Wenn Sie doc docTopic ausführen, wird innerhalb des doc-Befehls die Java-Klasse com.mathworks.mlservices.MLHelpServices.showReferencePage(docTopic) aufgerufen. Wenn eine Referenzseite für docTopic existiert, wird sie angezeigt und gibt einen Erfolgswert zurück. Wenn eine Referenzseite nicht existiert, wird ein Fehlerwert zurückgegeben, der dazu führt, dass helpwin(docTopic) aufgerufen wird. Irgendwo muss es einen Katalog geben, der Werte von docTopic mit individuellen Referenz-HTML-Dateien verbindet. Wie kann ich an diesem Katalog fummeln - oder kann ich einen für mein Paket erstellen?
MathWorker und @Yair, bitte gib mir genug undokumentiertes Seil, um mich aufzuhängen:)
Soweit ich weiß, ist dies nicht möglich und nicht von MathWorks beabsichtigt. Ich kenne auch keine undokumentierte Vorgehensweise. Soweit ich mich erinnere, sind die Schlüsselwörter für doc irgendwo fest codiert.
Abhängig von Ihrer Konfiguration können Sie Folgendes versuchen: Bereiten Sie Ihren eigenen doc -Befehl vor, der web(..., '-helpbrowser') verwendet, um HTML-Seiten im MATLAB-Hilfebrowser anzuzeigen:
Wenn Sie diese Funktion in eine Datei doc.m einfügen und das entsprechende Verzeichnis am Anfang des MATLAB-Pfads platzieren (siehe help addpath ), wird es anstelle der integrierten doc aufgerufen.
Natürlich können Sie auch eine andere Stelle verwenden, um Ihre benutzerdefinierte doc-Zuordnung zu speichern (z. B. eine Datei) oder eine Art dynamisches Suchschema verwenden.
UPDATE: Ab MATLAB R2012b ist die Option '-helpbrowser' von web undokumentiert. Dies hängt wahrscheinlich mit den GUI-Änderungen in dieser MATLAB-Version zusammen, zu denen auch der Hilfe-Browser gehört. web(..., '-helpbrowser') funktioniert weiterhin wie beabsichtigt, aber das kann sich in zukünftigen Versionen von MATLAB ändern. Soweit ich weiß, gibt es keine dokumentierte Möglichkeit, irgendeine HTML-Seite im Hilfebrowser in R2012b zu öffnen.
Tags und Links matlab