/** * Creates, if necessary, and returns the class JSDocs for this function * * @return {@link JSCommentMultiLine} containing JSDocs for this class */ @Nonnull public JSCommentMultiLine jsDoc () { if (m_aJSDoc == null) m_aJSDoc = new JSCommentMultiLine (); return m_aJSDoc; }
@Override @Nonnull public JSCommentMultiLine append (@Nullable final Object aObj) { add (aObj); return this; }
/** * add an xdoclet. * * @param sName * xdoclet name * @param aAttributes * Attributes to add * @return XDoclect to be filled */ @Nonnull public ICommonsMap <String, String> addXdoclet (@Nonnull final String sName, @Nonnull final Map <String, String> aAttributes) { final ICommonsMap <String, String> p = addXdoclet (sName); p.putAll (aAttributes); return p; }
/** * Append a text to an @-param tag. * * @param aParam * Param name * @return Comment part */ @Nonnull public JSCommentPart addParam (@Nonnull final JSVar aParam) { return addParam (aParam.name ()); }
format (aFormatter, " * ");
/** * add an xdoclet. * * @param sName * xdoclet name * @param aAttributes * Attributes to add * @return XDoclect to be filled */ @Nonnull public ICommonsMap <String, String> addXdoclet (@Nonnull final String sName, @Nonnull final Map <String, String> aAttributes) { final ICommonsMap <String, String> p = addXdoclet (sName); p.putAll (aAttributes); return p; }
/** * Append a text to an @-param tag. * * @param aParam * Param name * @return Comment part */ @Nonnull public JSCommentPart addParam (@Nonnull final JSVar aParam) { return addParam (aParam.name ()); }
format (aFormatter, " * ");
/** * Creates, if necessary, and returns the class JSDoc for this field * * @return {@link JSCommentMultiLine} containing JSDoc for this field */ @Nonnull public JSCommentMultiLine jsDoc () { if (m_aJSDoc == null) m_aJSDoc = new JSCommentMultiLine (); return m_aJSDoc; }
/** * add an xdoclet. * * @param sName * xdoclet name * @param sAttributeName * Attributes name * @param sAttributeValue * Attribute value * @return XDoclect to be filled */ @Nonnull public ICommonsMap <String, String> addXdoclet (@Nonnull final String sName, @Nonnull final String sAttributeName, @Nonnull final String sAttributeValue) { final ICommonsMap <String, String> p = addXdoclet (sName); p.put (sAttributeName, sAttributeValue); return p; }
@Override @Nonnull public JSCommentMultiLine append (@Nullable final Object aObj) { add (aObj); return this; }
/** * Creates, if necessary, and returns the class JSDocs for this function * * @return {@link JSCommentMultiLine} containing JSDocs for this class */ @Nonnull public JSCommentMultiLine jsDoc () { if (m_aJSDoc == null) m_aJSDoc = new JSCommentMultiLine (); return m_aJSDoc; }
/** * add an xdoclet. * * @param sName * xdoclet name * @param sAttributeName * Attributes name * @param sAttributeValue * Attribute value * @return XDoclect to be filled */ @Nonnull public ICommonsMap <String, String> addXdoclet (@Nonnull final String sName, @Nonnull final String sAttributeName, @Nonnull final String sAttributeValue) { final ICommonsMap <String, String> p = addXdoclet (sName); p.put (sAttributeName, sAttributeValue); return p; }
/** * Creates, if necessary, and returns the class JSDoc for this defined class * * @return {@link JSCommentMultiLine} containing JSDoc for this class */ @Nonnull public JSCommentMultiLine jsDoc () { if (m_aJSDoc == null) m_aJSDoc = new JSCommentMultiLine (); return m_aJSDoc; }
/** * Creates, if necessary, and returns the class JSDoc for this field * * @return {@link JSCommentMultiLine} containing JSDoc for this field */ @Nonnull public JSCommentMultiLine jsDoc () { if (m_aJSDoc == null) m_aJSDoc = new JSCommentMultiLine (); return m_aJSDoc; }
/** * Creates, if necessary, and returns the class JSDoc for this defined class * * @return {@link JSCommentMultiLine} containing JSDoc for this class */ @Nonnull public JSCommentMultiLine jsDoc () { if (m_aJSDoc == null) m_aJSDoc = new JSCommentMultiLine (); return m_aJSDoc; }