agilejzl/blog-eye Blog eye

Blog Eye, you know, a platform for sharing your blogs.

#62 (all)
Ruby (change)
6 seconds
over 2 years ago

This page shows an evaluation of the project's documentation.

Each class, module, method, etc. is given a grade based on how complete the docs are.

The bar above shows the distribution of these grades.

Please take a look
Undocumented
U
FileSizeValidator#check_validity! N
U
CkeditorAttachmentFileUploader N
U
SimpleCaptchaController N
U
CkeditorPictureUploader N
U
ApplicationController N
U
UserAvatarUploader N
U
BloggerController N
U
ApplicationHelper N
U
SystemMailWorker N
U
AdminController N
U
CommonUploader N
U
QiniuWorker N
U
Category N
U
Message N
U
Reply N
U
Code N
U
Post N
U
User N
U
Blog N
U
Users::RegistrationsController#is_uid_exist Ne
U
ApplicationHelper#js_reload_without_params Ne
U
Admin::MessagesController#mark_as_read Ne
U
Admin::PostsHelper#statuses_collection Ne
U
SimpleCaptchaController#update_captcha Ne
U
ApplicationHelper#draw_errors_message Ne
U
Users::RegistrationsController#create Ne
U
User.find_for_database_authentication Ne
U
Admin::PostsHelper#sources_collection Ne
U
Admin::HomeController#update_profile Ne
U
ApplicationHelper#code_tags_from_str Ne
U
ApplicationHelper#post_tags_from_str Ne
U
Admin::CategoriesController#destroy Ne
U
Frontend::CategoriesController#show Ne
U
Admin::CategoriesController#create Ne
U
Ckeditor::AttachmentFile#url_thumb Ne
U
Admin::CategoriesController#update Ne
U
Frontend::RepliesController#create Ne
U
ApplicationHelper#controller_title Ne
U
Admin::CategoriesController#index Ne
U
Frontend::UsersController#profile Ne
U
Admin::MessagesController#destroy Ne
U
ApplicationHelper#base_search_url Ne
U
WordCheck::Worker#first_sensitive Ne
U
Admin::RepliesController#destroy Ne
U
Admin::RepliesController#restore Ne
U
Admin::CategoriesController#show Ne
U
Admin::CategoriesController#edit Ne
U
ApplicationHelper#site_fullname Ne
U
FileSizeValidator#validate_each Ne
U
ApplicationHelper#meat_keywords Ne
U
Admin::MessagesController#index Ne
U
Frontend::BlogsController#index Ne
U
Frontend::PostsController#title Ne
U
Frontend::CodesController#index Ne
U
ApplicationHelper#default_title Ne
U
Frontend::CodesController#show Ne
U
Admin::PostsController#destroy Ne
U
Users::RegistrationsController Ne
U
Frontend::CategoriesController Ne
U
Admin::CodesController#destroy Ne
U
Frontend::HomeController#about Ne
U
Frontend::BlogsController#show Ne
U
Admin::MessagesController#show Ne
U
Frontend::PostsController#show Ne
U
Admin::RepliesController#index Ne
U
Admin::CodesController#update Ne
U
Admin::CodesController#create Ne
U
Admin::RepliesController#hide Ne
U
Admin::HomeController#profile Ne
U
Admin::PostsController#update Ne
U
Admin::PostsController#create Ne
U
Ckeditor::Picture#url_content Ne
U
Admin::CodesController#index Ne
U
QiniuWorker#init_user_avatar Ne
U
Admin::PostsController#index Ne
U
ApplicationHelper#omited_str Ne
U
FileSizeValidator#initialize Ne
U
ApplicationHelper#site_intro Ne
U
ApplicationHelper#page_title Ne
U
Admin::PostsController#show Ne
U
Admin::CodesController#show Ne
U
Admin::HomeController#index Ne
U
ApplicationController#title Ne
U
ApplicationHelper#js_reload Ne
U
Admin::CategoriesController Ne
U
Admin::CodesController#edit Ne
U
Admin::PostsController#edit Ne
U
ApplicationHelper#seo_intro Ne
U
SystemMailer#sensitive_mail Ne
U
Frontend::RepliesController Ne
U
Admin::PostsController#new Ne
U
ApplicationHelper#js_alert Ne
U
Admin::CodesController#new Ne
U
Frontend::PostsController Ne
U
Frontend::UsersController Ne
U
Frontend::BlogsController Ne
U
SystemMailer#welcome_mail Ne
U
Frontend::CodesController Ne
U
Admin::MessagesController Ne
U
Admin::RepliesController Ne
U
Ckeditor::AttachmentFile Ne
U
SystemMailWorker#perform Ne
U
Frontend::HomeController Ne
U
CommonUploader#filename Ne
U
FileSizeValidator#help Ne
U
Admin::CodesController Ne
U
Admin::PostsController Ne
U
Admin::HomeController Ne
U
Post#text_for_status Ne
U
Reply#published_time Ne
U
Message#created_time Ne
U
QiniuWorker#perform Ne
U
Post#published_time Ne
U
Code#published_time Ne
U
Blog#published_time Ne
U
User#whose_blogger Ne
U
User#blogger_title Ne
U
Admin::PostsHelper Ne
U
User#created_time Ne
U
User#gravatar_url Ne
U
WordCheck::Worker Ne
U
Ckeditor::Picture Ne
U
User#github_page Ne
U
User#human_name Ne
U
User#avatar_url Ne
U
User#email_md5 Ne
U
User#login= Ne
U
User#login Ne
U
Blog#type Ne
U
User#city Ne
U
ApplicationController#after_sign_in_path_for E
U
Admin::MessagesController#load_messages E
U
Admin::RepliesController#load_replies E
U
FrontendController#keep_redirect_url E
U
ApplicationController#load_messages E
U
ApplicationController#check_browser E
U
AdminController#load_categories E
U
BloggerController#load_blogger E
U
BloggerController#load_posts E
U
CommonUploader#secure_token E
U
FrontendHelper E
U
AdminHelper E
U
MailHelper E
U
AdminUser E
U
WordCheck E
U
Language E
U
Point E
U
CkeditorAttachmentFileUploader#filename E
U
CkeditorPictureUploader#filename E
U
FrontendController#title E
U
BloggerController#title E
U
AdminController#title E

Let's raise the visibility of documentation in Open Source!

This page is for agilejzl/blog-eye and is part of a project called "Inch CI", showing documentation measurements provided by Inch. Inch CI also provides a badge: (not counting low priority objects)

Can I have my own badges?

Sure! To get the badge for the project you are looking at, just click the badge next to the project name.

To register another project with Inch CI, just enter your username/repo on the homepage or sign in with GitHub!

Can I tell Inch which files to evaluate?

No problemo! Learn how ...

Can I configure a webhook for continuous integration?

Of course! Learn how ...

What is the goal of this?

I really think that posting badges for documentation in READMEs will benefit you (because people can see that your project is well documented) and our community in general by improving the visibility of documentation.

Let's start a discussion, let's raise the visibility of documentation, let's talk.

Suggestions, feedback, critique: Hit me up on Twitter or via issue.