doc pages

[ramagottfried]

I started working on the doc pages, but there's still a lot to do -- it would be great to get some help, @equilet if you have any time to pitch in on some of these that'd be awesome.

as a template, so far I think analyzer~ is the most fleshed out: https://github.com/CNMAT/CNMAT-Externs/blob/master/docs/refpages/cnmat_ref/analyzer~.maxref.xml

[ramagottfried]

looks like the doc pages aren't loading in windows also, need to check on why.

[equilet]

Thanks for the template, Rama. I'll start working on this in the weekend.

[equilet]

Here's my understanding of what we need to include, below. Please let me know if I'm omitting or misunderstanding anything (I saw the template, but of course we have options...):

---

name of object

• digest
• description details

snippets, if applicable

arguments

• argument x [type]
  • obligatory, optional
  • desc

attributes

• attribute x [type]
  • desc

messages

• message x
  • arguments, [type]
  • notes on inlets for message x

input

• input message(s) x [type]
  • desc

output

• output message x [type]
  • desc

see also

• name / desc

[equilet]

OK, it seems after further investigation that neither <inletlist> nor <outletlist> function, so instead we can use the designation above the discussion area using <misc> tags.

[equilet]