BCS ProDoc Javadoc Workbench

Preparing source code documentation in JavaDoc format can be an arduous task.

jdw01

The BCSProDoc tool offers relief to the programmer when such documentation is required.  This is accomplished by using the master detail scenario, a database memo component and a memo component whose visibility is set to false.

jdw02

This documentation is tracked by its fully qualified file specification.  So initially the end user must select the associated file.  If the file specification is not present in the repository it can easily be added.

I use a word processor to organize my docs and to check the spelling of its contents.  After completing my entry I select the entry and paste it to the clipboard by using the “Copy” option.  By default the copied text is placed on the clipboard.

Next I position my BCSPRoDoc tool to the appropriate file specification and paste the doc into the Memo portion of the Detail ( tab) of the workbench.  Invoke the popup menu and click the “Paste From Clipboard” option.  This action inserts the comment into the repository.  To prepare the comment for program utilization invoke the popup menu and click the “Format Comments” option.

The BCSProDoc workbench inserts the required “///” (minus double quotes) at the beginning of  each line.  When the construction is complete for every line the entire comment is copied to the clipboard where it can be pasted into the source code program at the appropriate location.  When the programmer invokes their favorite tool to produce the JavaDoc documentation you will notice a nicely formatted comment.  Because these comments are stored in the repository modification and re-creation is a breeze.  Once your comments are created simply paste them into the appropriate location within the source code.

A 32 bit executable program may be downloaded by clicking here.
A 64 bit executable program may be downloaded by clicking here.
The component documentation can be found by clicking here.
The source code may be found by clicking here.

Structures for the MySQL Repository is listed below.  Make sure a database named “csd” (minus quotes) exists on MySQL RDBMS.  After “csd” database exists simply import the script below to rebuild the required structures.

-- phpMyAdmin SQL Dump
-- version 4.5.1
-- http://www.phpmyadmin.net
--
-- Host: localhost
-- Generation Time: Mar 20, 2016 at 11:45 PM
-- Server version: 5.6.17
-- PHP Version: 5.5.12
 
SET SQL_MODE = "NO_AUTO_VALUE_ON_ZERO";
SET time_zone = "+00:00";
 
 
/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
/*!40101 SET NAMES utf8mb4 */;
 
--
-- Database: `csd`
--
 
-- --------------------------------------------------------
 
--
-- Table structure for table `ddt`
--
 
CREATE TABLE `ddt` (
  `id` int(11) NOT NULL,
  `mid` int(11) NOT NULL,
  `doc` mediumtext NOT NULL
) ENGINE=InnoDB DEFAULT CHARSET=latin1;
 
-- --------------------------------------------------------
 
--
-- Table structure for table `fst`
--
 
CREATE TABLE `fst` (
  `id` int(11) NOT NULL,
  `fs` varchar(255) NOT NULL
) ENGINE=InnoDB DEFAULT CHARSET=latin1;
 
--
-- Indexes for dumped tables
--
 
--
-- Indexes for table `ddt`
--
ALTER TABLE `ddt`
  ADD PRIMARY KEY (`id`);
 
--
-- Indexes for table `fst`
--
ALTER TABLE `fst`
  ADD PRIMARY KEY (`id`),
  ADD UNIQUE KEY `fs01` (`fs`);
 
--
-- AUTO_INCREMENT for dumped tables
--
 
--
-- AUTO_INCREMENT for table `ddt`
--
ALTER TABLE `ddt`
  MODIFY `id` int(11) NOT NULL AUTO_INCREMENT, AUTO_INCREMENT=15;
--
-- AUTO_INCREMENT for table `fst`
--
ALTER TABLE `fst`
  MODIFY `id` int(11) NOT NULL AUTO_INCREMENT, AUTO_INCREMENT=8;
/*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;
/*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;
/*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;

Mr. Arch Brooks, Software Engineer, Brooks Computing Systems, LLC authored this article.

One thought on “BCS ProDoc Javadoc Workbench”

  1. Pingback: BCS Productivity

Leave a Reply