cfdocs icon indicating copy to clipboard operation
cfdocs copied to clipboard

Type "property"

Open shaedrich opened this issue 8 years ago • 7 comments

There are some properties which are just a sub to specific function or tag just like a member function is for a specific data type.

For example columnList or recordcount.

shaedrich avatar Nov 14 '17 15:11 shaedrich

Yeah, it would be good to have a good way to document these...

So if you think about a query object, that can be returned from a number of functions or tags, maybe we need to be able to document query.json , with stuff like this:

{
   name:"query",
   type: "object",
   params: [
      {name:"recordcount", description:"The total number of records"},
      ...
   ]
}

The problem is there is already a query.json so may have to call it query-object.json or something.

pfreitag avatar Feb 01 '18 16:02 pfreitag

Why not query-return.json?

alorne avatar Oct 11 '18 18:10 alorne

Or using another folder for meta data like data types.

shaedrich avatar Oct 11 '18 18:10 shaedrich

Could something like so work. {"return-params": []}

alorne avatar Oct 11 '18 18:10 alorne

Hmmm… Does it (literally) "return" something?

shaedrich avatar Oct 11 '18 20:10 shaedrich

true, then how about result-params? In ACF at least that is where you define the variable in the cfquery tag

alorne avatar Oct 11 '18 20:10 alorne

true as well^^

shaedrich avatar Oct 11 '18 20:10 shaedrich