Organizing documentation, cleanup and polish

[heckj]

Documentation pass for swift distributed tracing

• adds curation (organization) for all the symbols
  • shifts any deprecated methods or types to the bottom of lists
• adds abstracts for all public types
• light copy editing to apply standard Swift styling

[ktoso]

A few comments for now

[heckj]

Coverage isn't perfect, but significantly improved:

Instrumentation:

   --- Experimental coverage output enabled. ---
                | Abstract        | Curated         | Code Listing
Types           | 100% (8/8)      | 75% (6/8)       | 0.0% (0/8)
Members         | 92% (11/12)     | 17% (2/12)      | 0.0% (0/12)
Globals         | 100% (1/1)      | 100% (1/1)      | 0.0% (0/1)

InMemoryTracing:

   --- Experimental coverage output enabled. ---
                | Abstract        | Curated         | Code Listing
Types           | 89% (8/9)       | 44% (4/9)       | 0.0% (0/9)
Members         | 71% (67/94)     | 31% (29/94)     | 0.0% (0/94)
Globals         | 33% (1/3)       | 100% (3/3)      | 0.0% (0/3)

Tracing:

   --- Experimental coverage output enabled. ---
                | Abstract        | Curated         | Code Listing
Types           | 74% (25/34)     | 71% (24/34)     | 0.0% (0/34)
Members         | 83% (141/169)   | 83% (141/169)   | 0.0% (0/169)
Globals         | 30% (10/33)     | 100% (33/33)    | 0.0% (0/33)

[ktoso]

Thank you, Joe! Awesome updates :-)