Development - Naming: Difference between revisions

From Bluefish Wiki
Jump to navigation Jump to search
m (Created page with '__NOTOC__ __NOEDITSECTION__ {{Man2top |lang=en |rev=2.0.0 |st=d |Title=2. Naming |prev=Man 2 ch12 |Subtitle=Chapter XII. Development guidelines |next=Man 2 ch12s03…')
 
m (moved Man 2 ch12s02 to Development - Naming: Title updates (BV))
 
(No difference)

Latest revision as of 11:13, 9 July 2010


2. Naming

For non-local functions, the name should preferably include a prefix that shows the part of bluefish it is used for. There are, furthermore, many often used abbreviations in the bluefish code, such as:

Abbreviations used in the Bluefish code

doc

A function for handling a specific document

bfwin

A function for handling a specific Bluefish window

cb

Callback, a function called after a button click or some other event

lcb

Local callback, a function called after an event, only used in this .c file

Here are such function names that show where they are from, what they handle, and/or what they do

Examples of function names in Bluefish

bmark_set_for_doc

Bookmark code, sets bookmarks for a document

spell_check_cb

Spell check code, this is a callback function (for a button)

project_open_from_file

Project code, opens a new project from a given file name