Documentation - Rokeya-Siddiqua/CSE327-Online-House-Rental-Management-System GitHub Wiki

Code Documentation

Tools for documentation: Javadoc

Javadoc is a tool for generating API documentation in HTML format from doc comments in source code.

How to Write Doc Comments for Javadoc

Follow the steps shows in the YouTube video below to generate documentation using Javadoc (given link)

how to generate Javadocs in Android Studio

Source code documentation link branch Rokeya

Source Code Documentation link branch Nusrat

source code documentation link master branch

Written Documentation

ReadMe file:

Brief introduction:

As we all know it is difficult to manage time for your daily needs in this fast-moving world. With this case there is a need for change in a technological field, there's an urgent must embrace and appreciate the power of innovative technology. So there is a vital situation to manage one in all the essential need that's a shelter or home for survival. If you are not known to an individual in some cities and want to rent a house than it's difficult to hunt out suitable aim time. Hence, there's a requirement to develop a House Rental management App that will simplify the work for the landlords and tenants so all their works are often done efficiently and effectively.

Online House Rental Management System is a platform where a person can easily find a suitable house within his requirements. Our goal is to satisfy the needs of rental house owners and general people who want to find their desire house easily. This App will provide the whole knowledge about houses which is accessible for Rent. If any Tenant wants to know the available house and the other related information like price, residential or not, structure of the flat, security, location details, they can know through this platform. Using this app the Landlords even have provision to post or update their property details whenever they want.

A tenant can search based on keywords such as location, prices, size. A tenant can also likes houses and check that later, decorate house both virtually and by same pictures, view in AR view, view through google map, pay rent, change currency. Customized user accounts that can be dynamically generated, Dynamic Content Updation, Automated Email and SMS facilities, Language changing facilities, Store transaction history, Comparison of properties based on location (distance from nearest hospital, school, airport, railway station etc). Registration: The system must provide login access to the registered users. The system must provide a registration page to enable new users(Builders, Brokers, Owners) to be registered. If the Registration is successful, an email is to be sent to the user with a temporarily generated password. When the user logs in for the first time after registration, he must be asked some secret questions. The new password provided by the user must be a secure password (not a dictionary based password).The registered users must be able to save and modify their profile which can be viewed by interested parties. The registered users must be able to view the history and summary of their activities. Notifications : Get notifications depending on his/her location. The landlord/owners shall have options to view the responses to their properties. The landlord/owners shall be provided with a form to update their property details. The landlords/owners must be able to confirm/decline the tenant's request. The landlords can also set a rent payment reminder per month. Extra facilities: Users can get help in both online (voice assistant, FAQ) and offline (pdf, slideshow, short video), complain, give ratings and feedback.

Quick Examples:

A doc comment is written in HTML and must precede a class, field, constructor or method declaration. It is made up of two parts -- a description followed by block tags. In this example, the block tags are @param, @return, and @see.

       /**

       * Returns an Image object that can then be painted on the screen.

       * The url argument must specify an absolute <a href="#{@link}">{@link URL}</a>. The name

       * argument is a specifier that is relative to the url argument. 

       * <p>

       * This method always returns immediately, whether or not the 

       * image exists. When this applet attempts to draw the image on

       * the screen, the data will be loaded. The graphics primitives 

       * that draw the image will incrementally paint on the screen. 

       *

       * @param  url  an absolute URL giving the base location of the image

       * @param  name the location of the image, relative to the url argument

       * @return      the image at the specified URL

       * @see         Image

       */

       public Image getImage(URL url, String name) {

       try {

       return getImage(new URL(url, name));

       } catch (MalformedURLException e) {

       return null;

       }

       }

links to more Documentations:

How to write code documentation in javadoc

Instructions on how to install the software:

Step 1: Configure your smartphone.

Step 2: Locate the software by typing the software name Online House Rent in the search option of google.

Step 3: Install a file manager.

Step 4: Download the software.

Step 5: Install the software.

Step 6: Disable Unknown Sources.

Use caution.

Project organization:

Online Rental House Android app portal is an internet portal dedicated to meet every aspect of the consumers needs in the Real Estate industry. It is a forum where Property Owners, Brokers, Tenants and Investors can exchange information, quickly, effectively and inexpensively. It features commercial and residential properties for rent and lease the fore properties, rates, locations, property news and also major events and happenings in the genre are the highlights of this portal.

The portal provides real estate directory for real estate agents, property dealers, builders and potential buyers of property.