Hi Jeff,

Sorry about the confusion.

I still see problems with the method docs. Here, there's a function with no
@method tag:

https://github.com/jeffschwartz/rtr/blob/master/rtr-router.html#L43

(Although perhaps that's an internal function and is not supposed to be
documented.)

And here, the description is on the same line as the @method tag:

https://github.com/jeffschwartz/rtr/blob/master/rtr-router.html#L43

>From looking at the core docs, it looks like the format should be similar
to your @attribute docs, with the description first, followed by:

@method methodName

On its own line. Here's an example:

https://github.com/Polymer/core-transition/blob/master/core-transition.html#L90

Thanks,
Arthur


On Tue, Jan 20, 2015 at 8:48 AM, Jeff Schwartz <[email protected]>
wrote:

> *Thanks, Arthur. I've removed all standalone scripts and inlined
> everything. I've modeled my JSDocs after those I found in core elements
> (i.e. core-ajax). I am still experiencing numerous issues after all of
> that:*
>
> http://jeffschwartz.github.io/rtr/components/rtr/
>
> I've spent more time on this than on building my components lol. Any
> advice you throw at this would be greatly appreciated. Thank you.
>
> On Thursday, January 15, 2015 at 8:58:36 PM UTC-5, arthure wrote:
>>
>> Two things I noticed -- your .js files don't include @element, which is
>> why you're seeing the Entity entries. Unfortunately, in my limited testing
>> the doc tool doesn't merge entries with the same name, so if you add
>> @element here, you end up with two rtr-history entries, for example, one
>> from the .html file and one from the .js file.
>>
>> In your case, since there's no other doc in the .html files, you can move
>> all of the docs to the .js files and you should be fine (I think).
>>
>> Also, the methods should be:
>>
>> Description
>>
>> @method methodname
>>
>> Unfortunately, unlike JSDoc the tool doesn't infer method names, so if
>> you leave out the @method it won't show up.
>>
>> Hope this helps.
>>
>> OK
>> Arthur
>>
>>
>> On Thu, Jan 15, 2015 at 6:29 AM, Jeff Schwartz <[email protected]>
>> wrote:
>>
>>> I forgot to mention that I am using the instructions found @
>>> https://www.polymer-project.org/docs/start/reusableelements.html to
>>> publish my element on github pages. You can view the page here
>>> http://jeffschwartz.github.io/rtr/components/rtr/.
>>>
>>> On Thursday, January 15, 2015 at 8:56:32 AM UTC-5, Jeff Schwartz wrote:
>>>>
>>>> How do I get core-component-page to include multiple .html and .js
>>>> files. I tried this:
>>>>     <core-component-page sources="['rtr-router.html', 'rtr-router.js',
>>>>     'rtr-history.html', 'rtr-history.js', 'rtr-route.html',
>>>> 'rtr-route.js',
>>>>     'rtr-lazyroute.html', 'rtr-lazyroute.js']"></core-component-page>
>>>>
>>>> but it doesn't work:
>>>>
>>>>
>>>> <https://lh4.googleusercontent.com/-cSlYtV-RtPk/VLfGiSd7XTI/AAAAAAAAGOA/UA8Y8_PplX8/s1600/Untitled.png>
>>>>
>>>> Thanks in advance.
>>>>
>>>  Follow Polymer on Google+: plus.google.com/107187849809354688692
>>> ---
>>> You received this message because you are subscribed to the Google
>>> Groups "Polymer" group.
>>> To unsubscribe from this group and stop receiving emails from it, send
>>> an email to [email protected].
>>> To view this discussion on the web visit https://groups.google.com/d/
>>> msgid/polymer-dev/011ca175-9e69-4646-87d6-7912e04d6885%
>>> 40googlegroups.com
>>> <https://groups.google.com/d/msgid/polymer-dev/011ca175-9e69-4646-87d6-7912e04d6885%40googlegroups.com?utm_medium=email&utm_source=footer>
>>> .
>>>
>>> For more options, visit https://groups.google.com/d/optout.
>>>
>>
>>  Follow Polymer on Google+: plus.google.com/107187849809354688692
> ---
> You received this message because you are subscribed to the Google Groups
> "Polymer" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to [email protected].
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/polymer-dev/fbf403b7-3ba3-4d91-808b-53d206e43d18%40googlegroups.com
> <https://groups.google.com/d/msgid/polymer-dev/fbf403b7-3ba3-4d91-808b-53d206e43d18%40googlegroups.com?utm_medium=email&utm_source=footer>
> .
>
> For more options, visit https://groups.google.com/d/optout.
>

Follow Polymer on Google+: plus.google.com/107187849809354688692
--- 
You received this message because you are subscribed to the Google Groups 
"Polymer" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/polymer-dev/CADSbU_xV_J8B7M4yYrBWn1bYY10167iHS-sAWr1A_Gw4yK7AdA%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to