We have moved to Github. Please open tickets there.

Opened 3 years ago

Last modified 14 months ago

#2232 new Documentation

Update documentation for Elgg core events and plugin triggers.

Reported by: brettp Owned by:
Priority: normal Milestone: Near Term Future Release
Component: Core Version: 1.8
Severity: minor Keywords:
Cc: brettp Difficulty:

Description


Change History (3)

comment:1 Changed 3 years ago by brettp

  • Type changed from task to documention

comment:2 Changed 2 years ago by ewinslow

  • Milestone changed from Elgg 1.8 to Elgg 1.9

Since these are going to be revisited in 1.9, I propose we take care of thoughtfully documenting them then.

comment:3 Changed 14 months ago by ewinslow

  • Version changed from 1.7 to 1.8

I was just thinking about this today. We should probably stick with our practice of keeping documentation close to the source. Most logical/helpful place I can think to do this is right above the call to elgg_trigger_*.

At the minimum we should document:

  • Parameter names and types
  • Default return value and type

Maybe we can just use existing phpdoc notation for this?

Beyond that:

  • High level description
  • Purpose of hook
  • Example use cases
Note: See TracTickets for help on using tickets.