Docs now show introduced versions for arguments and attributes

Zackster · August 12, 2022, 11:44am

I’ve updated Lucee docs (web and local for 5.3.10) to show introduced version for arguments and attributes (if specified) [LD-151] - Lucee

i.e. IsCustomFunction() :: Lucee Documentation

Unfortunately we haven’t been adding this info enough, if people want to dive and help, that would be awesome!

For example, would be great to file PRs for Lucee core and Extensions adding this meta data

an example for attributes [LDEV-3818] - Lucee

To add it for a tag for functions, it’s done like this

github.com

lucee/Lucee/blob/5.3.9/core/src/main/java/resource/fld/core-base.fld#L96


      
          		<argument-type>dynamic</argument-type>
          		<return>
          			<type>array</type>
          		</return>
          	</function>
          	
          	<!-- ApplicationPathCacheClear -->
          	<function>
          		<name>ApplicationPathCacheClear</name>
          		<class>lucee.runtime.functions.other.ApplicationPathCacheClear</class>
          		<introduced>5.3.8.149</introduced>
          		<description>flush the application.[cfc|cfm] path cache</description>
          		<return>
          			<type>void</type>
          		</return>
          	</function>
          	
          	<!-- arrayAppend -->
          	<function>
          		<name>arrayAppend</name>
          		<class>lucee.runtime.functions.arrays.ArrayAppend</class>

The s3 v2 extension for example has a few new functions (i.e. S3GeneratePresignedURL ) which could do with this being useful information being added

github.com

lucee/extension-s3/blob/master/source/fld/function.fld#L541


      
          			<default>10000</default>
          			<description>timeout for this execution</description>
          	    </argument>
          		<return>
          			<type>void</type>
          		</return>
          	</function>
          
          
	<!-- S3GeneratePresignedURL -->
          	<function>
          		<name>S3GeneratePresignedURL</name>
          		<class bundle-name="{bundle-name}" bundle-version="{bundle-version}">org.lucee.extension.resource.s3.function.S3GeneratePresignedURL</class>
          		<description>Generates a presigned URL pointing to the object given</description>
          		<argument>
          			<name>bucketNameOrPath</name>
          			<alias>bucket,bucketName,path</alias>
          			<type>string</type>
          			<required>Yes</required>
          			<description>This can be the bucketname or simple the virtual filesystem point for the file (if object name is no defined)</description>
          	    </argument>
          		<argument>

Which version/ branch you ask?

ok so for extensions, PR against the latest version.

If it’s something newly added in 6.0 file PRs against the 6.0 branch, however, for older stuff which was added before 6.0, please file PR and the 5.3 branch and it will be subsequently merged into 6.0

The best way to do this is to checkout a local copy and then use insight into code from gitlens and maybe github desktop to browse thru the commit history

Roberto_Marzialetti · August 12, 2022, 12:44pm

Great work Zack, as always!

Zackster · August 13, 2022, 4:08pm

cheers mate!

Just went back thru a few years of commits

this paves the way to publish docs from 6.0 soon, next round tags!

Zackster · August 13, 2022, 4:44pm

ok tags done too