Products

Solutions

Resources

Partners

Community

Blog

About

QA

Ideas Test

New Community Website

Ordinarily, you'd be at the right spot, but we've recently launched a brand new community website... For the community, by the community.

Yay... Take Me to the Community!

Welcome to the DNN Community Forums, your preferred source of online community support for all things related to DNN.
In order to participate you must be a registered DNNizen

HomeHomeDevelopment and...Development and...DNN Platform (o...DNN Platform (o...Where's the full documentation for the API and methods?Where's the full documentation for the API and methods?
Previous
 
Next
New Post
2/9/2014 3:41 AM
 

I looked at the docs (chm file) and it's the compiled xml documentation from the source code. There are many methods which do not have descriptions which means one can't know what a method does, unless one looks in the code and tries to understand what it does. This is very inefficient.

 For example, the PortalModuleBase.EditUrl Method. It has no description in the docs, yet it's used in many modules. How are module developers learning what each method does? 

 
New Post
2/9/2014 1:11 PM
 
The way we've always done it, trial and error.

Chris Hammond
Former DNN Corp Employee, MVP, Core Team Member, Trustee
Christoc.com Software Solutions DotNetNuke Module Development, Upgrades and consulting.
dnnCHAT.com a chat room for DotNetNuke discussions
 
New Post
2/9/2014 1:29 PM
 
Chris Hammond wrote:
The way we've always done it, trial and error.

 

After 10 years developing DNN with not even one-line descriptions for many important methods, I find this inexcusable!

 
New Post
2/9/2014 2:16 PM
 
Join in and contribute. That will reduce the inefficiency.

Best wishes,
- Richard
Agile Development Consultant, Practitioner, and Trainer
www.dynamisys.co.uk
 
New Post
2/9/2014 2:30 PM
 
Richard Howells wrote:
Join in and contribute. That will reduce the inefficiency.

 

I just started learning so I can't contribute now.

It's one friction after another. First I can't install from the full source (posted about this already) and now the API documentation sucks. 

I also need to know if my contributions will be included in the source. Otherwise it's mostly a waste of time unless there's an easy way to merge the xml documenation from an older source into the latest new one.

 

 
Previous
 
Next
HomeHomeDevelopment and...Development and...DNN Platform (o...DNN Platform (o...Where's the full documentation for the API and methods?Where's the full documentation for the API and methods?


These Forums are dedicated to discussion of DNN Platform and Evoq Solutions.

For the benefit of the community and to protect the integrity of the ecosystem, please observe the following posting guidelines:

  1. No Advertising. This includes promotion of commercial and non-commercial products or services which are not directly related to DNN.
  2. No vendor trolling / poaching. If someone posts about a vendor issue, allow the vendor or other customers to respond. Any post that looks like trolling / poaching will be removed.
  3. Discussion or promotion of DNN Platform product releases under a different brand name are strictly prohibited.
  4. No Flaming or Trolling.
  5. No Profanity, Racism, or Prejudice.
  6. Site Moderators have the final word on approving / removing a thread or post or comment.
  7. English language posting only, please.
What is Liquid Content?
Find Out
What is Liquid Content?
Find Out
What is Liquid Content?
Find Out