search

rootsdev / gedcomx-js

JavaScript library for GEDCOM X
http://rootsdev.org/gedcomx-js/
MIT License
10 stars 1 forks source link

How can we document extensions? #21

Open justincy opened 8 years ago

justincy commented 8 years ago

Two problems:

  1. Get the extensions of core data types to appear.
  2. Mark when something is an extension and which spec it belongs to.
justincy commented 8 years ago

If we can, it'd be nice to separate classes into namespaces based on core, rs, atom, records. I tried once but adding namespaces causes classes to be listed with {namespace}. as a prefix in the classes dropdown, such as core.Address. I don't like that; it prevent you from finding classes alphabetically. We would have to fork the template to use name instead of longname.

justincy commented 7 years ago

We are seeing extensions of core data types in the docs but we're not seeing methods of new data types from extensions in the docs. See DisplayProperties for an example; it's missing all getters and setters. In Field we see that it's properly picking up inherited methods.