标注和维护文档撰写

pull/2/head
HZXhuang 2 years ago
parent 487682837e
commit 85a54443bf

@ -0,0 +1,2 @@
<?xml version="1.0" encoding="UTF-8"?>
<Classdiagram><settings><option name="paintImplements" value="true" /><option name="paintDepends" value="true" /><option name="layoutOnChanges" value="false" /><option name="paintUses" value="true" /><option name="paintInner" value="true" /><option name="paintExtends" value="true" /></settings><classes><class name="net.micode.notes.data.NotesProvider" x="192" y="32"><option name="pinned" value="false" /><option name="fieldsExpanded" value="false" /><option name="constructorsExpanded" value="false" /><option name="methodsExpanded" value="false" /></class><class name="net.micode.notes.data.NotesDatabaseHelper" x="144" y="141"><option name="pinned" value="false" /><option name="fieldsExpanded" value="false" /><option name="constructorsExpanded" value="false" /><option name="methodsExpanded" value="false" /></class><class name="net.micode.notes.data.Contact" x="34" y="207"><option name="pinned" value="false" /><option name="fieldsExpanded" value="false" /><option name="constructorsExpanded" value="false" /><option name="methodsExpanded" value="false" /></class><class name="net.micode.notes.data.Notes" x="28" y="15"><option name="pinned" value="false" /><option name="fieldsExpanded" value="false" /><option name="constructorsExpanded" value="false" /><option name="methodsExpanded" value="false" /></class></classes><stickycomponents /><textcomponents /><connectors><connector from="net.micode.notes.data.NotesProvider" to="net.micode.notes.data.NotesDatabaseHelper"><anchor constraint="1" type="2" x="292" y="103" /><anchor constraint="1" type="2" x="285" y="141" /><decorator type="4" description="- mHelper" /></connector><connector from="net.micode.notes.data.NotesDatabaseHelper" to="net.micode.notes.data.NotesDatabaseHelper"><anchor constraint="1" type="2" x="376" y="212" /><anchor constraint="1" type="1" x="376" y="237" /><anchor constraint="1" type="1" x="422" y="237" /><anchor constraint="1" type="1" x="422" y="176" /><anchor constraint="1" type="2" x="412" y="176" /><decorator type="4" description="- mInstance" /></connector></connectors></Classdiagram>

@ -0,0 +1,115 @@
@startuml
title __DATA's Class Diagram__\n
namespace net.micode.notes {
namespace data {
class net.micode.notes.data.Contact {
}
}
}
namespace net.micode.notes {
namespace data {
class net.micode.notes.data.Notes {
}
}
}
namespace net.micode.notes {
namespace data {
class net.micode.notes.data.Notes.CallNote {
}
}
}
namespace net.micode.notes {
namespace data {
interface net.micode.notes.data.Notes.DataColumns {
}
}
}
namespace net.micode.notes {
namespace data {
class net.micode.notes.data.Notes.DataConstants {
}
}
}
namespace net.micode.notes {
namespace data {
interface net.micode.notes.data.Notes.NoteColumns {
}
}
}
namespace net.micode.notes {
namespace data {
class net.micode.notes.data.Notes.TextNote {
}
}
}
namespace net.micode.notes {
namespace data {
class net.micode.notes.data.NotesDatabaseHelper {
}
}
}
namespace net.micode.notes {
namespace data {
interface net.micode.notes.data.NotesDatabaseHelper.TABLE {
}
}
}
namespace net.micode.notes {
namespace data {
class net.micode.notes.data.NotesProvider {
}
}
}
net.micode.notes.data.Notes +-down- net.micode.notes.data.Notes.CallNote
net.micode.notes.data.Notes +-down- net.micode.notes.data.Notes.DataColumns
net.micode.notes.data.Notes +-down- net.micode.notes.data.Notes.DataConstants
net.micode.notes.data.Notes +-down- net.micode.notes.data.Notes.NoteColumns
net.micode.notes.data.Notes +-down- net.micode.notes.data.Notes.TextNote
net.micode.notes.data.Notes.CallNote .up.|> net.micode.notes.data.Notes.DataColumns
net.micode.notes.data.Notes.TextNote .up.|> net.micode.notes.data.Notes.DataColumns
net.micode.notes.data.NotesDatabaseHelper -up-|> android.database.sqlite.SQLiteOpenHelper
net.micode.notes.data.NotesDatabaseHelper +-down- net.micode.notes.data.NotesDatabaseHelper.TABLE
net.micode.notes.data.NotesProvider -up-|> android.content.ContentProvider
net.micode.notes.data.NotesProvider o-- net.micode.notes.data.NotesDatabaseHelper : mHelper
right footer
PlantUML diagram generated by SketchIt! (https://bitbucket.org/pmesmeur/sketch.it)
For more information about this tool, please contact philippe.mesmeur@gmail.com
endfooter
@enduml

@ -0,0 +1,73 @@
@startuml
title __DATA's Class Diagram__\n
namespace net.micode.notes {
namespace gtask.data {
class net.micode.notes.gtask.data.MetaData {
}
}
}
namespace net.micode.notes {
namespace gtask.data {
abstract class net.micode.notes.gtask.data.Node {
}
}
}
namespace net.micode.notes {
namespace gtask.data {
class net.micode.notes.gtask.data.SqlData {
}
}
}
namespace net.micode.notes {
namespace gtask.data {
class net.micode.notes.gtask.data.SqlNote {
}
}
}
namespace net.micode.notes {
namespace gtask.data {
class net.micode.notes.gtask.data.Task {
}
}
}
namespace net.micode.notes {
namespace gtask.data {
class net.micode.notes.gtask.data.TaskList {
}
}
}
net.micode.notes.gtask.data.MetaData -up-|> net.micode.notes.gtask.data.Task
net.micode.notes.gtask.data.Task -up-|> net.micode.notes.gtask.data.Node
net.micode.notes.gtask.data.Task o-- net.micode.notes.gtask.data.TaskList : mParent
net.micode.notes.gtask.data.Task o-- net.micode.notes.gtask.data.Task : mPriorSibling
net.micode.notes.gtask.data.TaskList -up-|> net.micode.notes.gtask.data.Node
right footer
PlantUML diagram generated by SketchIt! (https://bitbucket.org/pmesmeur/sketch.it)
For more information about this tool, please contact philippe.mesmeur@gmail.com
endfooter
@enduml

@ -0,0 +1,38 @@
@startuml
title __EXCEPTION's Class Diagram__\n
namespace net.micode.notes {
namespace gtask.exception {
class net.micode.notes.gtask.exception.ActionFailureException {
{static} - serialVersionUID : long
+ ActionFailureException()
+ ActionFailureException()
+ ActionFailureException()
}
}
}
namespace net.micode.notes {
namespace gtask.exception {
class net.micode.notes.gtask.exception.NetworkFailureException {
{static} - serialVersionUID : long
+ NetworkFailureException()
+ NetworkFailureException()
+ NetworkFailureException()
}
}
}
right footer
PlantUML diagram generated by SketchIt! (https://bitbucket.org/pmesmeur/sketch.it)
For more information about this tool, please contact philippe.mesmeur@gmail.com
endfooter
@enduml

@ -0,0 +1,65 @@
@startuml
title __REMOTE's Class Diagram__\n
namespace net.micode.notes {
namespace gtask.remote {
class net.micode.notes.gtask.remote.GTaskASyncTask {
}
}
}
namespace net.micode.notes {
namespace gtask.remote {
interface net.micode.notes.gtask.remote.GTaskASyncTask.OnCompleteListener {
}
}
}
namespace net.micode.notes {
namespace gtask.remote {
class net.micode.notes.gtask.remote.GTaskClient {
}
}
}
namespace net.micode.notes {
namespace gtask.remote {
class net.micode.notes.gtask.remote.GTaskManager {
}
}
}
namespace net.micode.notes {
namespace gtask.remote {
class net.micode.notes.gtask.remote.GTaskSyncService {
}
}
}
net.micode.notes.gtask.remote.GTaskASyncTask -up-|> android.os.AsyncTask
net.micode.notes.gtask.remote.GTaskASyncTask o-- net.micode.notes.gtask.remote.GTaskASyncTask.OnCompleteListener : mOnCompleteListener
net.micode.notes.gtask.remote.GTaskASyncTask o-- net.micode.notes.gtask.remote.GTaskManager : mTaskManager
net.micode.notes.gtask.remote.GTaskASyncTask +-down- net.micode.notes.gtask.remote.GTaskASyncTask.OnCompleteListener
net.micode.notes.gtask.remote.GTaskManager o-- net.micode.notes.gtask.data.TaskList : mMetaList
net.micode.notes.gtask.remote.GTaskSyncService -up-|> android.app.Service
right footer
PlantUML diagram generated by SketchIt! (https://bitbucket.org/pmesmeur/sketch.it)
For more information about this tool, please contact philippe.mesmeur@gmail.com
endfooter
@enduml

@ -0,0 +1,55 @@
@startuml
title __MODEL's Class Diagram__\n
namespace net.micode.notes {
namespace model {
class net.micode.notes.model.Note {
}
}
}
namespace net.micode.notes {
namespace model {
class net.micode.notes.model.Note.NoteData {
}
}
}
namespace net.micode.notes {
namespace model {
class net.micode.notes.model.WorkingNote {
}
}
}
namespace net.micode.notes {
namespace model {
interface net.micode.notes.model.WorkingNote.NoteSettingChangedListener {
}
}
}
net.micode.notes.model.Note o-- net.micode.notes.model.Note.NoteData : mNoteData
net.micode.notes.model.Note +-down- net.micode.notes.model.Note.NoteData
net.micode.notes.model.WorkingNote o-- net.micode.notes.model.Note : mNote
net.micode.notes.model.WorkingNote o-- net.micode.notes.model.WorkingNote.NoteSettingChangedListener : mNoteSettingStatusListener
net.micode.notes.model.WorkingNote +-down- net.micode.notes.model.WorkingNote.NoteSettingChangedListener
right footer
PlantUML diagram generated by SketchIt! (https://bitbucket.org/pmesmeur/sketch.it)
For more information about this tool, please contact philippe.mesmeur@gmail.com
endfooter
@enduml

@ -0,0 +1,101 @@
@startuml
title __TOOL's Class Diagram__\n
namespace net.micode.notes {
namespace tool {
class net.micode.notes.tool.BackupUtils {
}
}
}
namespace net.micode.notes {
namespace tool {
class net.micode.notes.tool.BackupUtils.TextExport {
}
}
}
namespace net.micode.notes {
namespace tool {
class net.micode.notes.tool.DataUtils {
}
}
}
namespace net.micode.notes {
namespace tool {
class net.micode.notes.tool.GTaskStringUtils {
}
}
}
namespace net.micode.notes {
namespace tool {
class net.micode.notes.tool.ResourceParser {
}
}
}
namespace net.micode.notes {
namespace tool {
class net.micode.notes.tool.ResourceParser.NoteBgResources {
}
}
}
namespace net.micode.notes {
namespace tool {
class net.micode.notes.tool.ResourceParser.NoteItemBgResources {
}
}
}
namespace net.micode.notes {
namespace tool {
class net.micode.notes.tool.ResourceParser.TextAppearanceResources {
}
}
}
namespace net.micode.notes {
namespace tool {
class net.micode.notes.tool.ResourceParser.WidgetBgResources {
}
}
}
net.micode.notes.tool.BackupUtils o-- net.micode.notes.tool.BackupUtils.TextExport : mTextExport
net.micode.notes.tool.BackupUtils +-down- net.micode.notes.tool.BackupUtils.TextExport
net.micode.notes.tool.ResourceParser +-down- net.micode.notes.tool.ResourceParser.NoteBgResources
net.micode.notes.tool.ResourceParser +-down- net.micode.notes.tool.ResourceParser.NoteItemBgResources
net.micode.notes.tool.ResourceParser +-down- net.micode.notes.tool.ResourceParser.TextAppearanceResources
net.micode.notes.tool.ResourceParser +-down- net.micode.notes.tool.ResourceParser.WidgetBgResources
right footer
PlantUML diagram generated by SketchIt! (https://bitbucket.org/pmesmeur/sketch.it)
For more information about this tool, please contact philippe.mesmeur@gmail.com
endfooter
@enduml

@ -0,0 +1,283 @@
@startuml
title __UI's Class Diagram__\n
namespace net.micode.notes {
namespace ui {
class net.micode.notes.ui.AlarmAlertActivity {
}
}
}
namespace net.micode.notes {
namespace ui {
class net.micode.notes.ui.AlarmInitReceiver {
}
}
}
namespace net.micode.notes {
namespace ui {
class net.micode.notes.ui.AlarmReceiver {
}
}
}
namespace net.micode.notes {
namespace ui {
class net.micode.notes.ui.DateTimePicker {
}
}
}
namespace net.micode.notes {
namespace ui {
interface net.micode.notes.ui.DateTimePicker.OnDateTimeChangedListener {
{abstract} + onDateTimeChanged()
}
}
}
namespace net.micode.notes {
namespace ui {
class net.micode.notes.ui.DateTimePickerDialog {
}
}
}
namespace net.micode.notes {
namespace ui {
interface net.micode.notes.ui.DateTimePickerDialog.OnDateTimeSetListener {
{abstract} + OnDateTimeSet()
}
}
}
namespace net.micode.notes {
namespace ui {
class net.micode.notes.ui.DropdownMenu {
}
}
}
namespace net.micode.notes {
namespace ui {
class net.micode.notes.ui.FoldersListAdapter {
}
}
}
namespace net.micode.notes {
namespace ui {
class net.micode.notes.ui.FoldersListAdapter.FolderListItem {
}
}
}
namespace net.micode.notes {
namespace ui {
class net.micode.notes.ui.NoteEditActivity {
}
}
}
namespace net.micode.notes {
namespace ui {
class net.micode.notes.ui.NoteEditActivity.HeadViewHolder {
}
}
}
namespace net.micode.notes {
namespace ui {
class net.micode.notes.ui.NoteEditText {
}
}
}
namespace net.micode.notes {
namespace ui {
interface net.micode.notes.ui.NoteEditText.OnTextViewChangeListener {
}
}
}
namespace net.micode.notes {
namespace ui {
class net.micode.notes.ui.NoteItemData {
}
}
}
namespace net.micode.notes {
namespace ui {
class net.micode.notes.ui.NotesListActivity {
}
}
}
namespace net.micode.notes {
namespace ui {
class net.micode.notes.ui.NotesListActivity.BackgroundQueryHandler {
}
}
}
namespace net.micode.notes {
namespace ui {
enum ListEditState {
}
}
}
namespace net.micode.notes {
namespace ui {
class net.micode.notes.ui.NotesListActivity.ModeCallback {
}
}
}
namespace net.micode.notes {
namespace ui {
class net.micode.notes.ui.NotesListActivity.NewNoteOnTouchListener {
}
}
}
namespace net.micode.notes {
namespace ui {
class net.micode.notes.ui.NotesListActivity.OnListItemClickListener {
}
}
}
namespace net.micode.notes {
namespace ui {
class net.micode.notes.ui.NotesListAdapter {
}
}
}
namespace net.micode.notes {
namespace ui {
class net.micode.notes.ui.NotesListAdapter.AppWidgetAttribute {
}
}
}
namespace net.micode.notes {
namespace ui {
class net.micode.notes.ui.NotesListItem {
}
}
}
namespace net.micode.notes {
namespace ui {
class net.micode.notes.ui.NotesPreferenceActivity {
}
}
}
namespace net.micode.notes {
namespace ui {
class net.micode.notes.ui.NotesPreferenceActivity.GTaskReceiver {
}
}
}
net.micode.notes.ui.DateTimePicker o-- net.micode.notes.ui.DateTimePicker.OnDateTimeChangedListener : mOnDateTimeChangedListener
net.micode.notes.ui.DateTimePicker +-down- net.micode.notes.ui.DateTimePicker.OnDateTimeChangedListener
net.micode.notes.ui.DateTimePickerDialog o-- net.micode.notes.ui.DateTimePicker : mDateTimePicker
net.micode.notes.ui.DateTimePickerDialog o-- net.micode.notes.ui.DateTimePickerDialog.OnDateTimeSetListener : mOnDateTimeSetListener
net.micode.notes.ui.DateTimePickerDialog +-down- net.micode.notes.ui.DateTimePickerDialog.OnDateTimeSetListener
net.micode.notes.ui.FoldersListAdapter +-down- net.micode.notes.ui.FoldersListAdapter.FolderListItem
net.micode.notes.ui.NoteEditActivity .up.|> net.micode.notes.ui.NoteEditText.OnTextViewChangeListener
net.micode.notes.ui.NoteEditActivity o-- net.micode.notes.ui.NoteEditActivity.HeadViewHolder : mNoteHeaderHolder
net.micode.notes.ui.NoteEditActivity +-down- net.micode.notes.ui.NoteEditActivity.HeadViewHolder
net.micode.notes.ui.NoteEditText o-- net.micode.notes.ui.NoteEditText.OnTextViewChangeListener : mOnTextViewChangeListener
net.micode.notes.ui.NoteEditText +-down- net.micode.notes.ui.NoteEditText.OnTextViewChangeListener
net.micode.notes.ui.NotesListActivity o-- net.micode.notes.ui.NotesListActivity.BackgroundQueryHandler : mBackgroundQueryHandler
net.micode.notes.ui.NotesListActivity o-- net.micode.notes.ui.NoteItemData : mFocusNoteDataItem
net.micode.notes.ui.NotesListActivity o-- net.micode.notes.ui.NotesListActivity.ModeCallback : mModeCallBack
net.micode.notes.ui.NotesListActivity o-- net.micode.notes.ui.NotesListAdapter : mNotesListAdapter
net.micode.notes.ui.NotesListActivity o-- net.micode.notes.ui.NotesListActivity.ListEditState : mState
net.micode.notes.ui.NotesListActivity +-down- net.micode.notes.ui.NotesListActivity.BackgroundQueryHandler
net.micode.notes.ui.NotesListActivity +-down- net.micode.notes.ui.NotesListActivity.ListEditState
net.micode.notes.ui.NotesListActivity +-down- net.micode.notes.ui.NotesListActivity.ModeCallback
net.micode.notes.ui.NotesListActivity +-down- net.micode.notes.ui.NotesListActivity.NewNoteOnTouchListener
net.micode.notes.ui.NotesListActivity +-down- net.micode.notes.ui.NotesListActivity.OnListItemClickListener
net.micode.notes.ui.NotesListActivity.ModeCallback o-- net.micode.notes.ui.DropdownMenu : mDropDownMenu
net.micode.notes.ui.NotesListAdapter +-down- net.micode.notes.ui.NotesListAdapter.AppWidgetAttribute
net.micode.notes.ui.NotesListItem o-- net.micode.notes.ui.NoteItemData : mItemData
net.micode.notes.ui.NotesPreferenceActivity o-- net.micode.notes.ui.NotesPreferenceActivity.GTaskReceiver : mReceiver
net.micode.notes.ui.NotesPreferenceActivity +-down- net.micode.notes.ui.NotesPreferenceActivity.GTaskReceiver
right footer
PlantUML diagram generated by SketchIt! (https://bitbucket.org/pmesmeur/sketch.it)
For more information about this tool, please contact philippe.mesmeur@gmail.com
endfooter
@enduml

@ -0,0 +1,61 @@
@startuml
title __WIDGET's Class Diagram__\n
namespace net.micode.notes {
namespace widget {
abstract class net.micode.notes.widget.NoteWidgetProvider {
{static} + COLUMN_BG_COLOR_ID : int
{static} + COLUMN_ID : int
{static} + COLUMN_SNIPPET : int
{static} + PROJECTION : String[]
{static} - TAG : String
+ onDeleted()
{abstract} # getBgResourceId()
{abstract} # getLayoutId()
{abstract} # getWidgetType()
# update()
- getNoteWidgetInfo()
- update()
}
}
}
namespace net.micode.notes {
namespace widget {
class net.micode.notes.widget.NoteWidgetProvider_2x {
+ onUpdate()
# getBgResourceId()
# getLayoutId()
# getWidgetType()
}
}
}
namespace net.micode.notes {
namespace widget {
class net.micode.notes.widget.NoteWidgetProvider_4x {
+ onUpdate()
# getBgResourceId()
# getLayoutId()
# getWidgetType()
}
}
}
net.micode.notes.widget.NoteWidgetProvider -up-|> android.appwidget.AppWidgetProvider
net.micode.notes.widget.NoteWidgetProvider_2x -up-|> net.micode.notes.widget.NoteWidgetProvider
net.micode.notes.widget.NoteWidgetProvider_4x -up-|> net.micode.notes.widget.NoteWidgetProvider
right footer
PlantUML diagram generated by SketchIt! (https://bitbucket.org/pmesmeur/sketch.it)
For more information about this tool, please contact philippe.mesmeur@gmail.com
endfooter
@enduml

File diff suppressed because one or more lines are too long
Loading…
Cancel
Save