Giter Club home page Giter Club logo

devhelp's Introduction

Devhelp

The Devhelp web page:

https://wiki.gnome.org/Apps/Devhelp

Installation of the Devhelp Flatpak

How to contribute

See the HACKING file.

Dependencies

  • GLib
  • GTK
  • WebKitGTK
  • Amtk
  • gsettings-desktop-schemas

Description

Devhelp is a developer tool for browsing and searching API documentation. It provides an easy way to navigate through libraries and to search by function, struct, or macro.

The documentation must be installed locally, so an internet connection is not needed to use Devhelp.

Devhelp works natively with GTK-Doc, so the GTK and GNOME libraries are well supported. But other development platforms can be supported as well, as long as the API documentation is available in HTML and a *.devhelp2 index file is generated.

Devhelp integrates with other applications such as Glade, Builder or Anjuta, and plugins are available for different text editors (gedit, Vim, Emacs, Geany, โ€ฆ).

Integration with other developer tools

Devhelp provides some command line options, such as --search and --search-assistant. A text editor plugin can for example launch the command devhelp --search function_name when a keyboard shortcut is pressed, with the function_name under the cursor.

Devhelp also provides a shared library, to integrate the GTK widgets inside an IDE. It is used for example by Builder and Anjuta.

For the --search command line option, see the class description of DhKeywordModel, the search string supports additional features useful for IDEs or other developer tools.

Other documentation

  • There is user documentation written in the Mallard format in the help/C/ directory. You can open that documentation with the yelp help/C/ command, or pressing F1 in the Devhelp application.

  • There is an API reference manual for the libdevhelp that can be built with GTK-Doc, see the gtk_doc build option.

devhelp's People

Contributors

frederic-peters avatar nacho avatar piotrdrag avatar dmustieles avatar changwoo avatar askhl avatar frandieguez avatar kelemeng avatar milocasagrande avatar marv-cz avatar yoseforb avatar aurisc4 avatar pesder avatar haaninjo avatar mcatanzaro avatar tmtfx avatar mirosnik1 avatar carlosgcampos avatar claudep avatar mtelka avatar mariobl avatar yarons avatar rffontenelle avatar takeshi-aihana avatar jordimas avatar muzena avatar jjardon avatar gheyret avatar toabctl avatar ookull avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.