Cinnamon developer documentation

About programming and getting involved with Linux Mint development
Forum rules
Topics in this forum are automatically closed 6 months after creation.
Post Reply
User avatar
xenopeek
Level 25
Level 25
Posts: 29507
Joined: Wed Jul 06, 2011 3:58 am

Cinnamon developer documentation

Post by xenopeek »

If you're interested in helping to develop Cinnamon or in writing applets / desklets / extension for Cinnamon then installing the cinnamon-doc package will be useful. This adds the Devhelp program in the Programming category of your menu and it has reference manuals for Cinnamon components and for libraries it uses.
Image
ilwegesk
Level 2
Level 2
Posts: 68
Joined: Wed Sep 30, 2020 2:22 am

Re: Cinnamon developer documentation

Post by ilwegesk »

Thanks for this hint, this helps really a lot!

One thing I noticed that the docs seems not to be fully up to date; at least one class is missing: In the "Cinnamon Javascript Reference Manual" under imports.ui.popupMenu, the PopupSubmenu refers to PopupSubMenuMenuItem which exists and can be used, but is missing in the devhelp.

(devhelp 3.36.2, Mint 20.2, Cinnamon 5.0.7)
ilwegesk
Level 2
Level 2
Posts: 68
Joined: Wed Sep 30, 2020 2:22 am

Re: Cinnamon developer documentation

Post by ilwegesk »

Might also be an idea to include the Clutter documentation also in Devhelp. It can be found online e.g. at https://gjs-docs.gnome.org/clutter8~8_api/

BTW: For beginners, some introduction would be helpful, to have an explanation about the different parts / libraries / frameworks that are used.
https://projects.linuxmint.com/referenc ... ation.html is a good starting point (which is also included in Devhelp under "Cinnamon Tutorials"), but Clutter is not mentioned there.
lofi
Level 2
Level 2
Posts: 65
Joined: Sun Mar 10, 2019 3:10 pm
Location: France

Re: Cinnamon developer documentation

Post by lofi »

wow, I've been doing lots of web searches for a long time. This is the holy grail.
mtwebster
Level 1
Level 1
Posts: 43
Joined: Sun Jun 17, 2012 1:29 pm

Re: Cinnamon developer documentation

Post by mtwebster »

The muffin/clutter 7 api docs should be used

I made a preset file you can import to set up the most common libraries you'll need preset file that can be imported into https://gjs-docs.gnome.org (Click the ... menu next to the search field, then Preferences):

https://gist.github.com/mtwebster/1b0c9 ... 9a4ebf8527
Post Reply

Return to “Programming & Development”