close Warning: Can't synchronize with repository "(default)" (Unsupported version control system "svn": No module named svn). Look in the Trac log for more information.

Changes between Version 5 and Version 6 of JCopCJEdit


Ignore:
Timestamp:
01/09/2011 01:05:30 PM (9 years ago)
Author:
malte.appeltauer
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • JCopCJEdit

    v5 v6  
    2121The documentation of applications is an important task in the software development process. In addition to architectural and infrastructural descriptions, the documentation of source-code artifacts is vital for understanding and evolving software systems. Therefore, most programming languages support source-code comments. However, most languages and programming environments restrict comments to plain text; text formating is not possible. To overcome this issue, tools like JavaDoc allow for the generation of HTML documents from source-code. This leads to a separation of source code from its formatted documentation, which is unintended in most cases since it requires additional effort to synchronize source code and comments.
    2222
     23[[Image(screenshot3.jpg, 500px)]]
     24
     25
     26
    2327== Overview ==
    2428The editor is equipped with syntax highlighting, an outline view, and a compilation/execution toolbar. Additionally, CJEdit allows to format [wiki:JCop] compilation units with rich text comments. For this task, the editor provides rich ''text formatting features'', such as font family, size, style, and color modifications. Through the combination of rich text and source code, CJEdit documents are single-source, executable representations of code and documentation.
    2529
    2630Both activities require different functionality, therefore our application supports focusing on the actual task at hand by offering only relevant tools, menus, and widgets. A context switch between text editing and programming features is either directly triggered by the user, or on text cursor change: While writing new text, the user can enter the programming mode by pushing a toolbar button. Whenever the text cursor is moved through the document from text to code and vice versa, the GUI elements are changed accordingly.
    27 The left screenshot on top of this page presents the application's rich text formatting  mode. The toolbar offers various text formatting actions. The right image depicts the programming mode, where the editor comes with an outline and a different toolbar. To support focusing on the source code, any rich text within the document is faded gray.
     31The left screenshot this page presents the application's rich text formatting  mode. The toolbar offers various text formatting actions. The right image depicts the programming mode, where the editor comes with an outline and a different toolbar. To support focusing on the source code, any rich text within the document is faded gray.
    2832
    2933== Implementation ==