Expand the introductory sections in the API docs

Issue #239 closed

Paolo Brandoli repo owner created an issue 2018-10-22

Expand the introduction sections in the API docs with explanations, examples, diagrams. Join the C++ and Objective-C section so the introduction for each functionality can be written only once.

Comments (8)

Paolo Brandoli reporter
- edited description
- 2018-10-26T19:52:00+00:00
Paolo Brandoli reporter
Addresses ~~#239~~. Added class diagrams for data, streams, acse, transform classes. Added sequence diagrams for data writer, writing custom pipe, SCU instantiation. Reorganized doc pages for data, imaging, streams, acse, transforms.

→ <<cset 40b01b81abd3ddfc2c3615dbb32f72a5ddd43416>>
- 2018-10-26T19:56:18+00:00
Paolo Brandoli reporter
Addresses ~~#239~~. Fixed documentation for ACSE, Dictionary, DICOMDIR, DIMSE, exceptions, memory, stream, definitions

→ <<cset 7b6eac19f699782ba7705056f7a794ea77330cdf>>
- 2018-11-05T14:37:20+00:00
Paolo Brandoli reporter
Addresses ~~#239~~. Removed old ObjectiveC documentation (now merged with C++ docs)

→ <<cset b09d011eb72c460b50aaf6a7512f0921290d8b7a>>
- 2018-11-05T14:37:20+00:00
Paolo Brandoli reporter
Addresses ~~#239~~. Added missing diagrams and UML model

→ <<cset b32be044c89e7eba2f828922b95b90b320cab7c4>>
- 2018-11-05T17:03:29+00:00
Paolo Brandoli reporter
Addresses ~~#239~~. Updated changes log

→ <<cset 9a845c19c9ff82c0e374dbad146c99ace8b58aac>>
- 2018-11-05T17:34:13+00:00
Paolo Brandoli reporter
- changed status to resolved
Resolved in cset a4f52026c6b4857ff47b67d335fbb58381ab32a4
- 2018-11-06T17:16:48+00:00
Paolo Brandoli reporter
- changed status to closed
Closed in 4.4.0.1
- 2019-01-24T15:58:36+00:00
Log in to comment

Assignee: Paolo Brandoli

Type: enhancement

Priority: major

Status: closed

Component: Documentation

Milestone: –

Version: –

Votes: 0

Watchers: 0