You are welcome to add a new tag.  Could be something like

  @workswith classOrInterface

Or maybe @knownstrands.

I'm not sure what you visualize for "display hierarchy" and "code
hinting".  Fundamentally, we have raw data in .json files and you can
write code to process and visualize that data.

I would prefer that folks hold off on adding new tags until after we get
the release out and merge the release branch back to develop.  Otherwise,
I think it will increase the likelihood of merge conflicts.

-Alex

On 6/6/17, 10:01 AM, "Harbs" <harbs.li...@gmail.com> wrote:

>It seems like there should be a mechanism to add arbitrary tags that
>include references to acceptable components. Maybe use interfaces to
>indicate swap-ability?
>
>What format would be best for tooling to display hierarchy and code
>hinting? Should there be a manifest file, or is the ASDoc enough for that?
>
>> On Jun 6, 2017, at 7:51 PM, Alex Harui <aha...@adobe.com.INVALID> wrote:
>> 
>> View beads have @viewbead ASDoc tag
>> Top-level components have @toplevel ASDoc tag.
>> 
>> All tags are output to tags.json and the ASDoc example could implement
>>any
>> sort of filtering based on those tags.  New tags I think can be added by
>> just adding them to the ASDoc and maybe telling the compiler to hide it
>> from Google Closure.
>> 
>> That's why I see the need for something that is more of an "application"
>> for our documentation.  The app can compute relationships based on data.
>> Volunteers are encouraged to improve this capability for our ASDoc.  We
>> also probably need to solve search engine interfaces for the app as
>>well.
>> 
>> BTW, I got the ASDoc in the CI server to work again.  Here are links to
>> the SWF version [1] and JS version[2].
>> 
>> -Alex
>> 
>> [1] 
>> 
>>https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fapachefle
>>xbuild.cloudapp.net%3A8080%2Fjob%2FFlexJS_ASDoc_Example%2FlastSucce&data=
>>02%7C01%7C%7C46e612dfe85445e0789308d4acfda6ad%7Cfa7b1b5a7b34438794aed2c17
>>8decee1%7C0%7C0%7C636323652817901308&sdata=s8fFgxBrse1R0EYwAuEQmDD9QSQFkw
>>lDDmQFoc9dNWU%3D&reserved=0
>> ssfulBuild/artifact/examples/flexjs/ASDoc/bin-debug/ASDoc.html
>> 
>> [2] 
>> 
>>https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fapachefle
>>xbuild.cloudapp.net%3A8080%2Fjob%2FFlexJS_ASDoc_Example%2FlastSucce&data=
>>02%7C01%7C%7C46e612dfe85445e0789308d4acfda6ad%7Cfa7b1b5a7b34438794aed2c17
>>8decee1%7C0%7C0%7C636323652817901308&sdata=s8fFgxBrse1R0EYwAuEQmDD9QSQFkw
>>lDDmQFoc9dNWU%3D&reserved=0
>> ssfulBuild/artifact/examples/flexjs/ASDoc/bin/js-debug/index.html
>> 
>> On 6/6/17, 8:46 AM, "Harbs" <harbs.li...@gmail.com> wrote:
>> 
>>> What do the annotations look like?
>>> 
>>> Maybe there should be some kind of manifest that documents beads and
>>> their relationships?
>>> 
>>> 
>>>> On Jun 6, 2017, at 5:46 PM, Alex Harui <aha...@adobe.com.INVALID>
>>>>wrote:
>>>> 
>>>> Definitely needs more.
>>>> 
>>>> In the ASDoc example, there is a checkbox to see just view beads.  I
>>>> have
>>>> added ASDoc annotations to the view beads so they show up when that
>>>> filter
>>>> is on.  I'm sure view beads may have been added since I first did
>>>>that,
>>>> and maybe the annotation accidentally got copied into new beads that
>>>> aren't view beads, but that's my idea for how to find tools in the
>>>> toolbox.
>>>> 
>>>> If folks like it, please add more annotations and propose and
>>>>implement
>>>> how to generalize the filtering so it isn't 40 checkboxes some day.
>>>> 
>>>> BTW, the ASDoc example on the CI server is broken.  That'll be my
>>>> stop-ship release bug for today.  Until then, you can build the
>>>>example
>>>> locally and see how the checkbox works.
>>>> 
>>>> Thanks,
>>>> -Alex
>>>> 
>>>> On 6/5/17, 10:58 PM, "Harbs" <harbs.li...@gmail.com> wrote:
>>>> 
>>>>> One of the most difficult part of dealing with FlexJS and beads is
>>>>> knowing what beads are available and what beads are interchangeable.
>>>>> 
>>>>> I think we need a system to programmatically be able to look up bead
>>>>> and
>>>>> strand relationships. This could be used by documentation as well as
>>>>> tooling to give hints as to what beads to use.
>>>>> 
>>>>> I think there’s been some discussion already on this, but I’m kind of
>>>>> fuzzy and it probably needs some more.
>>>>> 
>>>>> Harbs
>>>> 
>>> 
>> 
>

Reply via email to