MATLAB: comando force doc para abrir una página HTML de referencia especificada

Question

Digamos que he escrito una clase en un paquete, llamado mypackage.myclass. Escribí mi propia documentación HTML para el paquete y la clase, y la incluí en el navegador de ayuda de MATLAB, como se describe en the MATLAB documentation.

Puedo mostrar esta documentación en HTML usando el navegador de ayuda para navegar directamente hacia ella, pero al escribir doc mypackage.myclass no aparece; en su lugar, muestra cierta documentación HTML que se genera automáticamente en helpwin (que es una buena característica, pero no lo que quiero, la documentación generada automáticamente es demasiado técnica para mis usuarios).

¿Cómo puedo forzar doc para mostrar mi documentación, en lugar de la documentación generada automáticamente?

De manera equivalente:

Cuando se ejecuta doc docTopic, dentro de la instrucciones de control de la clase Java com.mathworks.mlservices.MLHelpServices.showReferencePage(docTopic) se llama. Si existe una página de referencia para docTopic, la muestra y devuelve un valor correcto. Si no existe una página de referencia, devuelve un valor de falla, que luego hace que se llame a helpwin(docTopic). En algún lugar debe haber algún catálogo que conecte valores de docTopic con archivos HTML de referencia individuales. ¿Cómo puedo jugar con ese catálogo, o puedo crear uno para mi paquete?

MathWorkers y @Yair, por favor, dame suficiente cuerda indocumentado ahorcarme con :)

Answer 1

Por lo que yo sé que esto no es posible y no intencionada por MathWorks. No sé de una forma indocumentada de hacer esto tampoco. Por lo que recuerdo, las palabras clave para doc están codificadas en alguna parte.

Dependiendo de su configuración, puede intentar lo siguiente: Prepare su propio comando doc que utiliza web(..., '-helpbrowser') para mostrar las páginas HTML en el navegador de la ayuda de MATLAB:

function doc(topic) 

    my_topics = { 
     'foo', 'foo.html' 
     'bar', 'bar/help/intro.html' 
    }; 

    for i = 1 : size(my_topics, 1) 
     if strcmpi(topic, my_topics{i, 1})  
      web(my_topics{i, 2}, '-helpbrowser'); 
      return; 
     end 
    end 

    % Fall back to MATLAB's doc. Note that our doc shadows MATLAB's doc. 
    docs = which('doc', '-all'); 
    old_dir = cd(); 
    c = onCleanup(@() cd(old_dir)); 
    cd(fileparts(docs{2})); 
    doc(topic); 
end 

Si pones esa función en un archivo doc.m y poner el el directorio correspondiente al comienzo de la ruta MATLAB (consulte help addpath) se llamará en lugar del doc incorporado.

Por supuesto, podría utilizar otro lugar para almacenar su asignación de documentos personalizada (un archivo, por ejemplo) o utilizar algún tipo de esquema de búsqueda dinámica.

ACTUALIZACIÓN: Como de MATLAB R2012b, la opción de '-helpbrowser'web es indocumentado. Esto probablemente esté relacionado con los cambios de la GUI en esa versión de MATLAB, que también incluye el navegador de ayuda. web(..., '-helpbrowser') sigue funcionando según lo previsto, pero eso puede cambiar en futuras versiones de MATLAB. Por lo que yo sé, no hay una forma documentada de abrir ninguna página HTML en el navegador de ayuda en R2012b.