Skip to content
SynProject Documentation Tool
Branch: master
Clone or download
Arnaud Bouchez
Arnaud Bouchez happy new 2019 year!
Latest commit 942bfad Jan 7, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
PasDocLight happy new 2019 year! Jan 7, 2019
.gitattributes From main repository Apr 28, 2014
.gitignore From main repository Apr 28, 2014
Default.ini From main repository Apr 28, 2014
ProjectCommons.pas happy new 2019 year! Jan 7, 2019
ProjectDiagrams.pas From main repository Apr 28, 2014
ProjectDiff.pas happy new 2019 year! Jan 7, 2019
ProjectDiffUnit.pas
ProjectEdit.res From main repository Apr 28, 2014
ProjectEditMain.dfm From main repository Apr 28, 2014
ProjectEditMain.pas happy new 2019 year! Jan 7, 2019
ProjectEditor.dfm From main repository Apr 28, 2014
ProjectEditor.pas happy new 2019 year! Jan 7, 2019
ProjectEditorCommit.dfm From main repository Apr 28, 2014
ProjectEditorCommit.pas happy new 2019 year! Jan 7, 2019
ProjectEditorProgram.dfm From main repository Apr 28, 2014
ProjectEditorProgram.pas happy new 2019 year! Jan 7, 2019
ProjectEditorRelease.dfm From main repository Apr 28, 2014
ProjectEditorRelease.pas happy new 2019 year! Jan 7, 2019
ProjectFormDocWizard.dfm From main repository Apr 28, 2014
ProjectFormDocWizard.pas happy new 2019 year! Jan 7, 2019
ProjectFormSelection.dfm updated SynProject GitHub repository with latest sources Aug 29, 2014
ProjectFormSelection.pas updated SynProject GitHub repository with latest sources Aug 29, 2014
ProjectFormViewOne.dfm From main repository Apr 28, 2014
ProjectFormViewOne.pas happy new 2019 year! Jan 7, 2019
ProjectFormViewTwo.dfm From main repository Apr 28, 2014
ProjectFormViewTwo.pas happy new 2019 year! Jan 7, 2019
ProjectFrameRisk.dfm From main repository Apr 28, 2014
ProjectFrameRisk.pas happy new 2019 year! Jan 7, 2019
ProjectFrameViewer.dfm From main repository Apr 28, 2014
ProjectFrameViewer.pas happy new 2019 year! Jan 7, 2019
ProjectGraphEdit.dfm From main repository Apr 28, 2014
ProjectGraphEdit.pas
ProjectMemoExSyntax.pas happy new 2019 year! Jan 7, 2019
ProjectParser.pas happy new 2019 year! Jan 7, 2019
ProjectRTF.pas happy new 2019 year! Jan 7, 2019
ProjectRes.rc SynProject is now able to generate the SAD as HTML optimized page Nov 5, 2014
ProjectRes.zip From main repository Apr 28, 2014
ProjectSections.pas happy new 2019 year! Jan 7, 2019
ProjectSpellCheck.dfm From main repository Apr 28, 2014
ProjectSpellCheck.pas happy new 2019 year! Jan 7, 2019
ProjectTrackerLogin.dfm From main repository Apr 28, 2014
ProjectTrackerLogin.pas happy new 2019 year! Jan 7, 2019
ProjectTrkTool.pas happy new 2019 year! Jan 7, 2019
ProjectTypes.pas happy new 2019 year! Jan 7, 2019
ProjectVersionBackup.dfm From main repository Apr 28, 2014
ProjectVersionBackup.pas happy new 2019 year! Jan 7, 2019
ProjectVersionCommit.dfm From main repository Apr 28, 2014
ProjectVersionCommit.pas happy new 2019 year! Jan 7, 2019
ProjectVersionCompare.dfm From main repository Apr 28, 2014
ProjectVersionCompare.pas happy new 2019 year! Jan 7, 2019
ProjectVersionMain.dfm From main repository Apr 28, 2014
ProjectVersionMain.pas happy new 2019 year! Jan 7, 2019
ProjectVersionPages.dfm From main repository Apr 28, 2014
ProjectVersionPages.pas happy new 2019 year! Jan 7, 2019
ProjectVersionSCR.dfm From main repository Apr 28, 2014
ProjectVersionSCR.pas happy new 2019 year! Jan 7, 2019
ProjectVersioning.pas happy new 2019 year! Jan 7, 2019
README.md Added README.md file Apr 28, 2014
SynProject.dpr ignored @@ in content Mar 18, 2017
SynProject.ico From main repository Apr 28, 2014
SynProject.res From main repository Apr 28, 2014
resource.bat SynProject is now able to generate the SAD as HTML optimized page Nov 5, 2014
synproject.css now the API reference (i.e. all source code definitions) will be stor… Nov 6, 2014
wizard2.png From main repository Apr 28, 2014

README.md

SynProject

Synopse SynProject is an open source application for code source versioning and automated documentation of Delphi projects.

Licensed under a GPL license.

Take a look at the SynProject official web site

Features

Its main features are:

  1. Local source code versioning;
  2. Automated documentation.

Source code versioning

  • handle multiple projects or libraries with the same program;
  • allow source code versioning with detailed commits;
  • can access to a PVCS tracker (more trackers are coming) and link the commits to the tickets;
  • allow automated source code backup (without any commit to document: it's like a daily snapshot of your files);
  • backups can be local (on your hard drive) or remote (on a distant drive);
  • you can make a visual "diff" and compare source code versions side by side in the graphical user interface;
  • you can see pictures (png jpeg bitmap icon) within the main user interface;
  • diff storage between version is very optimized, and use little disk space;
  • storage is based on .zip files and plain text files, so it's easy to work with.

Automated Documentation

  • follow a typical Design Inputs -> Risk Assessment -> Software Architecture -> Detailed Design -> Tests protocols -> Traceability matrix -> Release Notes workflow;
  • initial (marketing-level) Design Input can be refined into more precise Software Requirement Specifications;
  • Design Inputs can evolve during the project life: all documentation stay synchronized and you will have to maintain the DI and their description only at one place;
  • therefore, the process is meant to be compliant with the most precise documentation protocols (like IEC 62304); only one text file, formated like a wiki, contains the whole documentation;
  • it's very easy to add pictures, or formated source code (pascal, C, C++, C#, plain text) into the documentation;
  • word files (and then pdf) are created from this content, with full table of contents, picture or source code reference tables, unified page layout, customizable templates;
  • it's easy to add tables to your document, or link to other part or external resources * you can even put pure RTF content into your documentation;
  • pictures are centralized and captioned, people involved in the documentation are maintained once for the whole documentation;
  • document version numbering and cross-referencing is handled easily;
  • for pascal projects, the source code is parsed and all interface architecture is generated from the source; it's easy to browse classes, variables and functions from the documentation, and add reference to them to your document; the source code description can also be located in an external .sae file, therefore your original source code tree won't necessary be changed by the adding of comments;
  • all references are cross-linked: Software Architecture Document is created from the source code, and also is able to highlight the classes or methods - involved in implementing every Design Input, from the Software Design Document;
  • integrated GraphViz component, in order to create easily diagrams from plain text embedded into your documentation; * integrated fully featured text editor, with word wrapping, wiki-syntax buttons and keyboard shortcuts, and spell checking;
  • a step by step Wizard is available to create a new project, from supplied template files; another Wizard is already available, to browse your documentation workflow, and check its consistency or set up its parameters;
  • the documentation is integrated to the Versioning system above.

Of course, it's a full Open Source - GPL licensed - project. Source code (for Delphi 6/7) is available and maintained, since it is used by our internal projects (including our little mORMot).

You can’t perform that action at this time.