This developer guide is sourced directly from the docs directory of the Codename One Git repository. The documentation is written in AsciiDoc, reviewed through pull requests, and published from the main branch to multiple targets.
To contribute updates, clone the repository, create a feature branch, and edit the AsciiDoc files in docs/developer-guide. Follow the steps in the CONTRIBUTING guidelines to open a GitHub pull request (PR) instead of using the deprecated community wiki. Each PR is automatically linted and built by continuous integration, then reviewed by a maintainer before it is merged. Once merged, the content is rendered to the web manual at https://www.codenameone.com/manual/ and to the downloadable PDF at https://www.codenameone.com/files/developer-guide.pdf. Periodically, major revisions are collected for print-on-demand distribution.
While this guide focuses on tutorial and conceptual material, the complete API reference remains available in the Codename One JavaDoc. The source code for the framework and this manual lives alongside each other in Git, so improvements to documentation and code can evolve together through the same contribution workflow.
Authors
This document includes content from multiple authors and community wiki edits. If you edit pages within the guide feel free to add your name here alphabetized by surname:
Rights & Licensing
You may copy/redistribute/print this document without prior permission from Codename One. However, you may not charge for the document itself although charging for costs such as printing is permitted.
Notice that while you can print and reproduce sections arbitrarily such changes must explicitly and clearly state that this is a modified copy and link to the original source at https://www.codenameone.com/manual/ in a clear way!
Conventions
This guide uses some notations to provide tips and further guidance.
In case of further information that breaks from the current tutorial flow we use a sidebar as such:
Dig deeper into some details that don’t quite fit into the current flow. We use sidebars for things that are an important detour, you can skip them while reading but you might want to come back and read them later.
Here are common conventions for highlighting notes:
|
Important
|
This is an important note |
|
Tip
|
This is a helpful tip |
|
Note
|
This is a general informational note, something interesting but not crucial |
|
Warning
|
This is a warning something we should pay attention to |
This convention is used when we refer to a button or a widget to press in the UI. E.g. press the button labeled Press Here.
Quotes are presented as:
This is a quote
Bold is used for light emphasis on a specific word or two within a sentence.