Añadiendo documentación externa en KDevelop

A la hora de programar es muy importante no perder la concentración, y por ello muchos de los entornos de programación integrados como KDevelop nos brindan la posibilidad de trabajar en modo “pantalla completa”, para no distraernos con otros elementos del escritorio o no caer en la tentación de revisar cuentas de correo o navegar a páginas Webs. Sin embargo, en muchas ocasiones se nos hace indispensable acudir a la documentación de alguna librería o revisar anotaciones sobre cualquier aspecto del que nos haya surgido una duda, y KDevelop viene preparado con un completo sistema de documentación al que además se le pueden añadir contenidos adicionales. En esta pequeña entrada os describo como añadir documentación externa en KDevelop.
Si abrís la pestaña de documentación que aparece a la derecha del IDE podéis contemplar todas las entradas de documentación dentro de la subpestaña “contents”. Hay manuales y guías de referencias muy buenas, en la siguiente imagen aparece la vista de la documentación de “C++ notations” la cual es muy útil y completa.
Para insertar en la pestaña de contenidos del plugin de documentación una documentación propia tendremos que seguir los siguientes pasos:
- Ir al menú “Settings” -> “Configure KDevelop”.
- Ir a la pestaña “Documentation”.
- Pulsar el botón “Add”.
- Especificar los campos “Location”, “Title” y “Type”. El campo “Location” será el fichero principal de la documentación. En mi caso he creado un enlace a la documentación de las librerías OpenCV y el cuadro de configuración queda así.

Una vez realizados estos pasos, la nueva entrada en la documentación aparecerá en la parte superior de la pestaña que muestra todos los contenidos de documentación disponibles, y podremos acceder a ella como si de un navegador Web se tratase. Esto nos evitará tener que cambiar de ventanas y centrarnos mejor en nuestro trabajo
. Además podremos quitar los documentos que no nos interesen que aparezcan en la ventana que aparece a la derecha del IDE deseleccionando el checkbox correspondiente a la columna TOC.
loading...



Últimos comentarios